Trace APIs - 2024.1 English

AI Engine System Software Driver Reference Manual (UG1642)

Document ID: UG1642
Release Date: 2024-05-30
Version: 2024.1 English

Introduction
Overview
AI Engine
AI Engine Configuration
Identification of Software Components
AI Engine Driver External Interfaces
Software Components Description
Device Agnostic Architecture
Alignment with Tools
Provision of Generic APIs, Support Platforms
Support Different Operating Systems
Ability to Run on Different Processors
AI Engine Embedded Software Driver Modules
Introduction
Component ID
Component ID: AIE_SSW_DRV_GLOBAL
Component ID: AIE_SSW_DRV_CORE
Component ID: AIE_SSW_DRV_MEM
Component ID: AIE_SSW_DRV_LOCK
Component ID: AIE_SSW_DRV_STREAMSW
Component ID: AIE_KERNEL_DRIVER
AI Engine Kernel Driver Structure
AI Engine Kernel Driver Runtime Resource Configuration and Control Interface
Component ID: AIE_SSW_DRV_PL
Component ID: AIE_SSW_DRV_DMA
Component ID: AIE_SSW_DRV_EVENT
Component ID: AIE_SSW_DRV_TRACE
Component ID: AIE_SSW_DRV_PERF
Component ID: AIE_SSW_DRV_TIMER
Component ID: AIE_SSW_DRV_PM
Component ID: AIE_SSW_DRV_IOBACKEND
Component ID: AIE_FAL
Linux FPGA Manager
PLM
AI Engine Configuration
AI Engine Configuration and AI Engine Partitions
XRT and AI Engine Driver
Boot Sequences of AI Engine and AIE-ML
AI Engine Boot Sequence
AIE-ML Boot Sequence
AI Engine Configuration and Termination Flow
Configuration Time for AI Engine Array
AI Engine OOB GEMM Application
Introduction
Implementation
AI Engine Configuration with PDI
AI Engine Partition Termination
Reset and Reloading Procedure for the AI Engine Array
AI Engine Error and Events Handling
AI Engine Runtime Error Handling
AI Engine Runtime Events Handling
AI Engine Error/Events Routing Configuration
AI Engine Status Dump and Errors Statistics
Partition SysFS Nodes
Tile SysFS Nodes
AI Engine Runtime Tracing Events and Profiling
Tracing
Profiling
AI Engine Frequency Scaling
AI Engine Resource Management
Benefits for Resource Manager Migration to FAL
Error Messages During Resource Conflict
Linux
Baremetal
AI Engine I/O Transaction
Interrupt Usage
Software Safety Consideration
Resource Utilization for Embedded Software
AI Engine Initialization Sequence
TEE/Global Platform
Linux and Bare-metal Comparison
APIs
AI Engine Software APIs
Functions
XAie_SetupPartitionConfig
XAie_CfgInitialize
_XAie_PartitionIsolationInitialize
XAie_Finish
XAie_SetIOBackend
XAie_MemAllocate
XAie_MemFree
XAie_MemSyncForCPU
XAie_MemSyncForDev
XAie_MemGetVAddr
XAie_MemGetDevAddr
XAie_MemAttach
XAie_MemDetach
XAie_TurnEccOff
XAie_TurnEccOn
XAie_StartTransaction
XAie_SubmitTransaction
XAie_ExportTransactionInstance
XAie_FreeTransactionInstance
XAie_IsDeviceCheckerboard
XAie_UpdateNpiAddr
XAie_ExportSerializedTransaction
XAie_FreeSerializedTransaction
XAie_ClearTransaction
XAie_PerfUtilization
Trace APIs
XAie_TraceEvent
XAie_TraceStartEvent
XAie_TraceStopEvent
XAie_TracePktConfig
XAie_TraceModeConfig
XAie_TraceGetState
XAie_TraceGetMode
XAie_TraceControlConfig
XAie_TraceControlConfigReset
XAie_TracePktConfigReset
XAie_TraceEventList
XAie_TraceResetEvent
Profiling APIs
XAie_PerfCounterGet
XAie_PerfCounterSet
XAie_PerfCounterEventValueSet
XAie_PerfCounterEventValueReset
XAie_PerfCounterControlReset
XAie_PerfCounterGetControlConfig
Additional Resources and Legal Notices
Finding Additional Documentation
Support Resources
References
Revision History
Please Read: Important Legal Notices

Back to home page