• State Resolved
  • Locked Locked
  • Replies 4 replies
  • Subscribers 98 subscribers
  • Views 620 views
  • Users 0 members are here
Support feedback
Options
Options
Related

This thread has been locked.

If you have a related question, please click the "Ask a related question" button in the top right corner. The newly created question will be automatically linked to this question.

Keystone I/II API Document(s)

John Westmoreland43
Guru 13915 points

Hello All,

Does a document exist that outlines all of the API's that are available to Keystone I and Keystone II devices?

I see it stated in many places that OpenMP, for instance, is supported but I don't see any specific API document that sufficiently outlines the calls in such a way that it could be used as a programmer's guide.  This is an example, maybe a bad one in case I have missed something.  (openmp.org. e.g.)

But, the point here is - I don't see a Programmer's UG of sorts that outlines all of the API calls.  I think having to expect someone to pour though source code and go, ok, there it is, I think I understand that now; isn't a way to go about API's that should be documented.  I just saw a thread in this forum that was nothing more than that - Oh, the API is documented in the source code; don't worry, the tools are only a 4GB download - so you should be able to find it.

Some of the OOB demos are OK - but would appear to be almost nothing more than a loader that downloads specific code and runs with little or no documentation or explanation.  

Is there such a thing as a Keystone I/II Programmer's API UG at this point that is comprehensive?  I don't find pointers to wikis to be too helpful at this point.

If I have missed something; please point that out to me immediately.

Thanks In Advance,
John W.

  • 0
    TI__Mastermind 43955 points

    Hi John W,

    For PDK-keystone - II package, you will find a good documentation on API. When I installed the package, mcsdk_3_01_01_04_setuplinux.bin,  able to find at "../pdk_keystone2_3_01_01_04/packages/API%20Documentation.html" which covers the following topics.

    Following API documentation is available:

    As well for bios_6_37_03_30 you will find an exhaustive API documentation at ".. /bios_6_37_03_30/docs/cdoc/index.html" 

    In addition to these,  I could see WIKIS covering most of the purposes like how to bring up the Keystone- II board with bootloader and linux, how to install the MCSDK packages of Keystone- II, how to run the examples e.t.c. in the following WIKI pages.

    The main user guide with sub-links to other topics like tools, development, exploring the subsystems e.t.c., 

    http://processors.wiki.ti.com/index.php/MCSDK_UG_Chapter_Tools

    http://processors.wiki.ti.com/index.php/MCSDK_UG_Chapter_Developing_KS_II_First_App

    Regards,

    Shankari

    -------------------------------------------------------------------------------------------------------

    Please click the Verify Answer button on this post if it answers your question.
    --------------------------------------------------------------------------------------------------------

  • 0 in reply to Shankari G
    Guru 13915 points
    Hello Shankari,

    It would be helpful in the ocean of wikis to actually have links to all of the current documentation.
    Having to 'force' someone to download GB's of info just to read the API docs really isn't acceptable in my opinion.
    Please note that I am talking about Keystone I and Keystone II. Specifically the CC678 regarding Keystone I.

    Regards,
    John
  • 0 in reply to John Westmoreland43
    Guru 13915 points

    Shankari,

    Following what you outlined for the C6678 for the PDK:

    When you press on the Doxygen selection for the API docs:

    The PDF's are there - but the html path is obviously broken.

    Regards,
    John

  • 0 in reply to John Westmoreland43
    TI__Mastermind 43955 points

    Hi John,

    As these APIs are part of MCSDK packages, we have to download and install the MCSDK. Since it is huge, it is not available online.

    yes, as you said, not able to open the  Doxygen output of Platform API located at  "file:///home/shankari/Downloads/y/pdk_keystone2_3_01_01_04/packages/ti/platform/docs/platform/html/index.html" 

    Thanks for the observation. I will file a bug and get it corrected.

    By the way you are able to access the API available at file":///home/shankari/Downloads/y/pdk_keystone2_3_01_01_04/packages/API%20Documentation.html" ??

    Regards,

    Shankari

    -------------------------------------------------------------------------------------------------------

    Please click the Verify Answer button on this post if it answers your question.
    --------------------------------------------------------------------------------------------------------