Framework Components API Reference

fc-p01

Modules

The Framework Components are made up of the following modules:

• IALG Management
  • DSKT2 - XDAIS utility library for instantiating XDAIS algorithms, and managing their memory resources.

• HDINTC Interrupt registration
  • HDINTC - Application interface to the interrupt registery manager. Registers non-BIOS, non-dispatched interrupt service handlers to register and sychronize with HDVICP interrupts. This utilizes the XDAIS IRES interface (HDVICP specific), which XDAIS algorithms that use HDVICP hardware accelarators must implement.

• HDVICPSYNC Kaleido synchronization
  • HDVICPSYNC - API for synchronization between codecs and HDVICP coprocessor usage

• VICPSYNC VICP synchronization
  • VICPSYNC - API for synchronization between codecs and VICP coprocessor usage

• MEMUTILS Memory APIs -MEMUTILS - API for cache management functions called by algorithms. Also has APIs for managing address translation on devices with MMUs.

• EDMA3 QDMA Resource Management
  • DMAN3 - DMA Manager library. A library for managing DMA hardware resources for XDAIS algorithms. This utilizes the IDMA3 interface (EDMA3 specific), which XDAIS algorithms must implement to enable DMAN3 to manage their DMA resources.
  • ACPY3 - High-Performance Functional DMA Interface and common library for EDMA3-based devices.

• General Purpose Resource Management
  • RMAN - Generic Resource Manager Interface and common library.
  • IRESMAN Interfaces for developing IRES resources and resource managers.

In addition, several specific resource management interfaces are managed within the Framework Components product:

• EDMA3 Resources
  • IRES_EDMA3CHAN - EDMA3 specific IRES Protocol implementation.
  • IRESMAN_EDMA3CHAN - EDMA3 specific IRESMAN implementation.
• HDVICP Resources
  • IRES_HDVICP - HDVICP specific IRES Protocol implementation.
  • IRESMAN_HDVICP - HDVICP specific IRESMAN implementation.
• VICP Resources
  • IRES_VICP - VICP specific IRES Protocol implementation.
  • IRES_VICP2 - VICP specific IRES Protocol implementation for DM360 VICP.
  • IRESMAN_VICP - VICP specific IRESMAN implementation.
  • IRESMAN_VICP2 - VICP specific IRESMAN implementation for DM360 VICP.
• SDMA Resources
  • IRES_SDMA - SDMA specific IRES Protocol implementation.
  • IRESMAN_SDMA - SDMA specific IRESMAN implementation.
  • SCPY - Functional SDMA Interface and library for SDMA usage in OMAP3430.
• Other Resources
  • SHMBUF Shared Memory Resource - A Linux Shared Memory Buffer
  • ADDRSPACE Address Space Resource - An OS agnostic hardware address access mechanism.
  • MEMTCM Shared TCM Memory Resource - A CMEM (Linux) based ARM TCM memory resource manager

Additionally, there are several utility modules provided:

• ti.sdo.fc.utils - Utilities which frameworks can built upon, including Design By Contract (DBC) and Debug tracing tools (DBG).
• GT - provides "Generic Trace" facilities, to support portable, flexible tracing mechanisms.