sammielove45 / propgcc

Automatically exported from code.google.com/p/propgcc
1 stars 1 forks source link

Documentation correction/clarification for the Propeller GCC Library documentation #26

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Two corrections/clarifications for the Propeller GCC Library documentation at 
http://propgcc.googlecode.com/hg/doc/Library.html:

The page references _simple_printf, but the routine is actually named 
__simple_printf (two leading underscores) in both the header file and library 
code.  This should be fixed in either the code or (more likely) in the 
documentation.

The following note (IMHO) would be a useful addition at the end of the "Simple 
Serial Driver (Prefix SSER:)" section:

Note that because the Simple Serial Driver runs completely in the local cog, it 
shares the cog's DIRA and OUTA register with the calling code.  Therefore, 
avoid overwriting the DIRA/OUTA bits corresponding to the Simple Serial 
Driver's TX and RX pins.  You can do this when setting or clearing bits for 
other I/O devices by using bit-setting and bit-masking instead of direct 
assignment (e.g. DIRA |= 3 or DIRA &= ~3 instead of DIRA = 3 or DIRA = 0).  
This is always a good idea, but failing to do this in any code that uses the 
Simple Serial Driver will result in unpredictable I/O.

Original issue reported on code.google.com by tjstefan...@charter.net on 29 Jan 2012 at 4:40

GoogleCodeExporter commented 9 years ago
Thank for for these suggestions. I've implemented both changes and checked them 
in.

- Eric

Original comment by ersm...@hfx.eastlink.ca on 4 Feb 2012 at 9:36