Documentation for “Zerocat Chipflasher” as of Wed, 01 Jan 2025 22:07:31 +0100
Repository:
Version: v2.1.0-0-850cd7bce
Branch: master

../../firmware2/src/FullDuplexSerial.spin.flashrom.html

Propeller Spin/PASM Compiler 'OpenSpin' (c)2012-2016 Parallax Inc. DBA Parallax Semiconductor.
Version 1.00.78
Compiling...
../../firmware2/src/FullDuplexSerial.spin
Done.
Program size is 716 bytes
********************************************
*  Full-Duplex Serial Driver v1.2          *
*  Author: Chip Gracey, Jeff Martin        *
*  Copyright (c) 2006-2009 Parallax, Inc.  *
*  See end of file for terms of use.       *
********************************************


Changes, introduced for Zerocat Chipflasher:

* Fix memory access to cog flag, remove initialized data.
* PUB str(stringptr) -> PUB str(stringptr) : strlength


Object "../../firmware2/src/FullDuplexSerial" Interface:

PUB  start(rxpin, txpin, mode, baudrate) : 
PUB  stop
PUB  rxflush
PUB  rxcheck : 
PUB  rxtime(ms) : 
PUB  rx : 
PUB  tx(txbyte)
PUB  str(stringptr) : 
PUB  dec(value)
PUB  hex(value, digits)
PUB  bin(value, digits)

Program:  175 Longs
Variable: 18 Longs

___________________________________________
PUB  start(rxpin, txpin, mode, baudrate) : 

 Start serial driver - starts a cog
 returns false if no cog available

 mode bit 0 = invert rx
 mode bit 1 = invert tx
 mode bit 2 = open-drain/source tx
 mode bit 3 = ignore tx echo on rx

_________
PUB  stop

 Stop serial driver - frees a cog

____________
PUB  rxflush

 Flush receive buffer

_______________
PUB  rxcheck : 

 Check if byte received (never waits)
 returns -1 if no byte received, $00..$FF if byte

__________________
PUB  rxtime(ms) : 

 Wait ms milliseconds for a byte to be received
 returns -1 if no byte received, $00..$FF if byte

__________
PUB  rx : 

 Receive byte (may wait for byte)
 returns $00..$FF

_______________
PUB  tx(txbyte)

 Send byte (may wait for room in buffer)

______________________
PUB  str(stringptr) : 

 Send string

_______________
PUB  dec(value)

 Print a decimal number

_______________________
PUB  hex(value, digits)

 Print a hexadecimal number

_______________________
PUB  bin(value, digits)

 Print a binary number

******************************************************************************
                        TERMS OF USE: MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

******************************************************************************