Documentation for NXP C Library Methods?

cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

Documentation for NXP C Library Methods?

1,522 Views
lpcware
NXP Employee
NXP Employee
Content originally posted in LPCWare by dcomer on Fri Mar 19 11:46:50 MST 2010
I've searched high and low, but apparently missed something on the NXP site. For the CodeRed/LPCxpresso LPC111x family, where is the documentation of NXP libraries? For example, GPIOInit(), I2CInit(), etc.? Sorry for the rather (to some) obvious question, but nowhere in the example, CodeRead compiler install, etc. can I seem to find a PDF file with documentation.

Thanks in advance

Dave
0 Kudos
Reply
5 Replies

1,427 Views
lpcware
NXP Employee
NXP Employee
Content originally posted in LPCWare by dcomer on Sat Mar 20 10:37:07 MST 2010
I believe I have it now. Perhaps someone can comment on my conclusion. Apparently, the provided example software is based on CMSIS 1p30; at present the only the core due to ARM removing the middleware until all CMSIS participants can agree on the standard. The remaining (non-core specific) example code was developed independantly or used CMSIS 1P20 or earlier...hence documentation is iffy until CMSIS middleware is complete. Just trying to get a handle on how to apprach NXP development strategy.

Dave
0 Kudos
Reply

1,427 Views
lpcware
NXP Employee
NXP Employee
Content originally posted in LPCWare by dcomer on Fri Mar 19 15:21:26 MST 2010
Thanks. I'll take a look. There is a file included with the LPC11xx version called "lpc17xx.cmsis.driver.library.zip" that is similar, and it too is rather limited. There is a table on the NXP site:

http://ics.nxp.com/literature/other/microcontrollers/pdf/arm.mcu.free.nxp.software.pdf

that has all but the Cortex-M0 parts. My guess is that this family is so new NXP doesn't have such a document completed just yet; that and the fact that CMSIS seems to be the way of the ARM library future and the common library used now if being updated/replaced by CMSIS compliant libraries. So, perhaps later. The product is looking promising so I hope this is temporary.

Dave
0 Kudos
Reply

1,427 Views
lpcware
NXP Employee
NXP Employee
Content originally posted in LPCWare by igorsk on Fri Mar 19 14:30:26 MST 2010
LPC1700's DriverLibrary includes a CHM file. It's not great (auto-generated from Doxygen comments), but does help.
0 Kudos
Reply

1,427 Views
lpcware
NXP Employee
NXP Employee
Content originally posted in LPCWare by dcomer on Fri Mar 19 13:27:30 MST 2010
Indeed as observered through the example code. Clearly one can hover the mouse over a function call in sample code. What I am seeking is documentation on the library to get a 10,000ft view of what functions are available. Again, I can open all the include files and do this the hard way but doesn' it seem reasonable to you to have the library functions documented - the equivalent of  the "Stellaris Family Driver Library User's Guide" perhaps called "LPCxpresso Driver Library User's Guide"???
0 Kudos
Reply

1,427 Views
lpcware
NXP Employee
NXP Employee
Content originally posted in LPCWare by Luis Digital on Fri Mar 19 12:06:58 MST 2010
Hello,

The source code is usually commented:

Quote:
Function name:        GPIOSetDir

Descriptions:        Set the direction in GPIO port

parameters:            port num, bit position, direction (1 out, 0 input)
Returned value:        None



But certainly, the documentation (and examples) is very poor when compared with other microcontrollers, such as AVR, 8051, Propeller, etc.
0 Kudos
Reply