Bios MCSDK 2.0 API Documentation Locations

From Texas Instruments Embedded Processors Wiki

Contents 1 Overview 2 Documentation Locations 2.1 Bit Coprocessor LLD (BCP) 2.2 Chip Support Library (CSL) 2.3 Communications Port Programming Interface Low Level Driver (CPPI LLD/Packet DMA) 2.4 DSP Library (DSPLIB) 2.5 EDMA3 Low Level Driver (EDMA3 LLD) 2.6 FFT Accelerator Coprocessor Low Level Driver (FFTC LLD) 2.7 Hyperlink Low Level Driver (Hyplnk LLD) 2.8 Imaging Library (IMGLIB) 2.9 Interprocessor Communication (IPC) 2.10 Math Library (MATHLIB) 2.11 Network Developers Kit (NDK) 2.12 Packet Accelerator Low Level Driver (PA LLD) 2.13 PCI Express Low Level Driver (PCIe LLD) 2.14 Queue Manager Subsystem Low Level Driver (PA LLD) 2.15 Serial RapidIO Low Level Driver (SRIO LLD) 2.16 TCP3 Decoder Low Level Driver (TCP3D LLD) 2.17 TCP3 Decoder Low Level Driver (TCP3D LLD)

Overview

The Bios MCSDK comes with a host of libraries that implement software APIs that can be called by the user's code. The documentation for the APIs is not in the MCSDK User's Guide nor is it in the Getting Started Guide. These APIs are typically documented with via Doxygen markup contained within the source code header files, and then Doxygen is used to create the actual documentation in a .html (and in some cases a Windows Help (.chm) or Latex) format which is provided with the libraries. The location of this documentation is not yet standardized across all of the components of the MCSDK. So, this page is provided as a reference to where each library's documentation can be found within the MCSDK file structure.

Note the following:

• The "variable" MCSDK_INSTALL_DIR will be used in each of the following sections. This translates to the location where the MCSDK installer was pointed when the install occurred. Replace this with your install location to resolve the location on your system
• Directories with a revision number (Example: dsplib_c66x_3_0_0_8) may differ slightly based on the revision of each component.
• Directories with a device number in the name (Example: pdk_C6678_1_0_0_14) may differ slightly based on the device number.

Documentation Locations

Bit Coprocessor LLD (BCP)

<MCSDK_INSTALL_DIR>
  |
  |-pdk_C6678_1_0_0_14
    |
    |-packages
      |
      |-ti
        |
        |-drv
          |
          |-bcp
            |
            |-docs
              |
              |-doxygen
                |
                |-html
                  |
                  |-index.html

Chip Support Library (CSL)

<MCSDK_INSTALL_DIR>
  |
  |-pdk_C6678_1_0_0_14
    |
    |-packages
      |
      |-ti
        |
        |-csl
          |
          |-docs
            |
            |-doxygen
              |
              |-html
                |
                |-index.html

Communications Port Programming Interface Low Level Driver (CPPI LLD/Packet DMA)

<MCSDK_INSTALL_DIR>
  |
  |-pdk_C6678_1_0_0_14
    |
    |-packages
      |
      |-ti
        |
        |-drv
          |
          |-cppi
            |
            |-docs
              |
              |-doxygen
                |
                |-html
                  |
                  |-index.html

DSP Library (DSPLIB)

<MCSDK_INSTALL_DIR>
  |
  |- dsplib_c66x_3_0_0_8 
     |
     |-doxygen
       |
       |-html
         |
         |-dsplib_html
           |
           |-index.html

EDMA3 Low Level Driver (EDMA3 LLD)

<MCSDK_INSTALL_DIR>
  |
  |-edma3_lld_02_11_02_04
    |
    |-packages
      |
      |-ti
        |
        |-sdo
          |
          |-edma3
            |
            |-drv
              |
              |-docs
                |
                |-html
                  |
                  |-index.html

FFT Accelerator Coprocessor Low Level Driver (FFTC LLD)

<MCSDK_INSTALL_DIR>
  |
  |-pdk_C6678_1_0_0_14
    |
    |-packages
      |
      |-ti
        |
        |-drv
          |
          |-fftc
            |
            |-docs
              |
              |-doxygen
                |
                |-html
                  |
                  |-index.html

Hyperlink Low Level Driver (Hyplnk LLD)

<MCSDK_INSTALL_DIR>
  |
  |-pdk_C6678_1_0_0_14
    |
    |-packages
      |
      |-ti
        |
        |-drv
          |
          |-hyplnk
            |
            |-docs
              |
              |-doxygen
                |
                |-html
                  |
                  |-index.html

Imaging Library (IMGLIB)

<MCSDK_INSTALL_DIR>
  |
  |-imglib_c66x_3_0_1_0
    |
    |-docs
      |
      |-doxygen
        |
        |-html
          |
          |-imglib_html
            |
            |-index.html

Interprocessor Communication (IPC)

<MCSDK_INSTALL_DIR>
  |
  |-ipc_1_22_03_23
    |
    |-docs
      |
      |-doxygen
        |
        |-html
          |
          |index.html

Math Library (MATHLIB)

<MCSDK_INSTALL_DIR>
  |
  |-mathlib_c66x_3_0_0_0
    |
    |-docs
      |
      |-doxygen
        |
        |-html
          |
          |-mathlib_html
            |
            |-index.html

Network Developers Kit (NDK)

<MCSDK_INSTALL_DIR>
  |
  |-ndk_2_20_04_26   
    |
    |-docs
      |
      |-cdoc
        |
        |-index.html

Packet Accelerator Low Level Driver (PA LLD)

<MCSDK_INSTALL_DIR>
  |
  |-pdk_C6678_1_0_0_14
    |
    |-packages
      |
      |-ti
        |
        |-drv
          |
          |-pa
            |
            |-docs
              |
              |-doxygen
                |
                |-html
                  |
                  |-index.html

PCI Express Low Level Driver (PCIe LLD)

<MCSDK_INSTALL_DIR>
  |
  |-pdk_C6678_1_0_0_14
    |
    |-packages
      |
      |-ti
        |
        |-drv
          |
          |-pcie
            |
            |-docs
              |
              |-doxygen
                |
                |-html
                  |
                  |-index.html

Queue Manager Subsystem Low Level Driver (PA LLD)

<MCSDK_INSTALL_DIR>
  |
  |-pdk_C6678_1_0_0_14
    |
    |-packages
      |
      |-ti
        |
        |-drv
          |
          |-qmss
            |
            |-docs
              |
              |-doxygen
                |
                |-html
                  |
                  |-index.html

Serial RapidIO Low Level Driver (SRIO LLD)

<MCSDK_INSTALL_DIR>
  |
  |-pdk_C6678_1_0_0_14
    |
    |-packages
      |
      |-ti
        |
        |-drv
          |
          |-srio
            |
            |-docs
              |
              |-doxygen
                |
                |-html
                  |
                  |-index.html

TCP3 Decoder Low Level Driver (TCP3D LLD)

<MCSDK_INSTALL_DIR>
  |
  |-pdk_C6678_1_0_0_14
    |
    |-packages
      |
      |-ti
        |
        |-drv
          |
          |-tc3pd
            |
            |-docs
              |
              |-doxy
                |
                |-html
                  |
                  |-index.html

TCP3 Decoder Low Level Driver (TCP3D LLD)

<MCSDK_INSTALL_DIR>
  |
  |-pdk_C6678_1_0_0_14
    |
    |-packages
      |
      |-ti
        |
        |-drv
          |
          |-tcp3e
            |
            |-docs
              |
              |-doxy
                |
                |-html
                  |
                  |-index.html

Leave a Comment