XC Library Reference

Technical questions regarding the XTC tools and programming with XMOS.
User avatar
Jerry
Member++
Posts: 30
Joined: Sat Dec 12, 2009 7:14 pm
Location: Silicon Valley

XC Library Reference

Post by Jerry »

Where can I find a reference for all of the built-in functions callable from XC?

I'm talking about functions such as write_sswitch_reg() and configure_out_port(). Programming XC on XMOS Devices has some usage examples, but nothing like a reference. Man pages would be ideal, but anything beyond what is in Programming XC on XMOS Devices would be helpful. I've searched http://www.xmos.com/support/documentation and didn't find anything useful.


User avatar
monk_is_batman
Active Member
Posts: 38
Joined: Wed Jun 09, 2010 3:20 am
Location: Maine, USA

Post by monk_is_batman »

I haven't found much from XMOS on those types of functions so far. There are brief explanations in the installation of the tools, for me its in C:\Program Files\XMOS\DesktopTools\10.4\doc\libs\html\index.html. Under global you can find a list of a lot of functions in the tools not mentioned in many other places.
User avatar
Andy
Respected Member
Posts: 279
Joined: Fri Dec 11, 2009 1:34 pm

Post by Andy »

You can access all the function prototypes and their descriptions in the relevant header files.

In the Project Explorer on the left hand side, expand your project > Includes > C:/.../target/include

The most relevant are xs1.h, xclib.h and xccompat.h.
User avatar
Berni
Respected Member
Posts: 363
Joined: Thu Dec 10, 2009 10:17 pm

Post by Berni »

Oh thanks for pointing out that html file, i was looking for that!
User avatar
Woody
XCore Addict
Posts: 165
Joined: Wed Feb 10, 2010 2:32 pm

Post by Woody »

I always use the HTML page: it's easy to get to within Windows:

Start Button / All Programs/ XMOS / XMOS Desktop Tools 10.4 / Desktop Tools Documentation