TI E2E Community
Stellaris® ARM® Microcontrollers
Stellaris® ARM® LM3S Microcontrollers Forum
Could the StellarisWare 'utils' documentation be clearer?
The utils folder in a StellarisWare installation contains (appropriately enough) a set of "utility" modules; eg,
cmdline - simple command-line interpreter
softi2c - software I2C on GPIO pins
softssi - software SSI on GPIO pins
softuart - software UART on GPIO pins
uartstdio - simple stdio interface on a UART
Currently, there seems to be no standalone documentation for these - instead, the same documentation is repeated verbatim in each of the DevKit user manuals
So my first suggestion is: Wouldn't it be simpler to have a single document for these?
Of course, this would be referenced by the individual DevKit user manuals, and they could supply any details specific to the particular kit.
The descriptions of the module files are somewhat ambiguous; eg,
EK-LM3S6965 Firmware Development Package User's Guide
This module is contained in
utils/uartstdio.c, with utils/uartstdio.h containing the API definitions (sic) for use by applications.
This module is contained in
Now, "definitions" there is OK in general English usage, but is incorrect in specific 'C' language terminology.
So my second suggestion is: it should be changed to "declarations"
It might (only might) have helped this user: http://www.keil.com/forum/18997/
Andy NeilWouldn't it be simpler to have a single document for these?
It would have answered this question: http://e2e.ti.com/support/microcontrollers/stellaris_arm_cortex-m3_microcontroller/f/471/p/116948/415274.aspx#415274
Thanks for the suggestion. I'll pass it along to the software team.
Still confusing users: http://e2e.ti.com/support/microcontrollers/stellaris_arm/f/901/p/245433/859069.aspx#859069
I wanted to let you know that TivaWare 2.0 has a utils doc, thanks to your excellent suggestion. I have attached it for your reference.
Friend Andy has been traveling internationally - may not see this as quickly as usual.
But we did! Very comprehensive - and brings together most (if not all) of past requests - good job - thank you.
We do pleasantly note what appears (at least to us) to be new - the accommodation of "wider bus" SPI serial flash devices. Your new utils doc now includes "SPIFlashxxxxRead()." (where xxxx may be Dual or Quad) This greatly speeds, any/all "read transactions" w/these advantaged, compact devices. We see no mention of corresponding "write" either bi or quad...
We note that these (dual/quad) SPI functions did not appear w/in StellarisWare (9453) - and the new utility doc does not describe how the expanded SPI pins are to be set-up/configured - or if these new features are confined to a subset of the new MCU releases.
As your time allows - we'd appreciate such detail. The new utility doc is a very nice addition & should benefit many...
I'm glad you like the new doc. These new modes are available on the new TM4C129x devices. You can find out more here.
Seek (from Sue) and ye shall find... (within a world record - sub 3 minutes!!!)
Above & beyond... as usual.
Thanks again - you remain a spectacular resource to many - and are greatly appreciated...
All content and materials on this site are provided "as is". TI and its respective suppliers and providers of content make no representations about the suitability of these materials for any purpose and disclaim all warranties and conditions with regard to these materials, including but not limited to all implied warranties and conditions of merchantability, fitness for a particular purpose, title and non-infringement of any third party intellectual property right. TI and its respective suppliers and providers of content make no representations about the suitability of these materials for any purpose and disclaim all warranties and conditions with respect to these materials. No license, either express or implied, by estoppel or otherwise, is granted by TI. Use of the information on this site may require a license from a third party, or a license from TI.
TI is a global semiconductor design and manufacturing company. Innovate with 100,000+ analog ICs andembedded processors, along with software, tools and the industry’s largest sales/support staff.