Documentation for “Zerocat Chipflasher” as of Wed, 24 Jun 2026 07:28:36 +0200
Repository: git://zerocat.org/zerocat/projects/chipflasher.git
Version: v3.0.0-0-b445ef922
Branch: master

protocol.spin.connect.html

Propeller Spin/PASM Compiler 'OpenSpin' (c)2012-2016 Parallax Inc. DBA Parallax Semiconductor.
Version 1.00.78
Compiling...
protocol.spin
Done.
Program size is 28 bytes

______________________________________________________________________________
********************************************************* File starts here ***
Zerocat Chipflasher --- Flash free firmware, kick the Management Engine.

Copyright (C) 2020, 2021, 2022, 2026  Kai Mertens 

File protocol.spin --- serial communication with the `connect` utility

This file is part of Zerocat Chipflasher.

See end of file for terms of use.

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


# Object Summary

Object "protocol" Interface:

PUB  start

Program:  3 Longs
Variable: 0 Longs


# Loaded Objects


# Included Files


## ./ascii.spin


### Constants

* ASCII Control Characters
* Printable Characters
* Printable, Reserved Characters


# Constants

Must match with: ../../firmware1/src/libcommon/protocol.h

* Generic File Transmission and Program Control

* Obsolete Single Command Bytes for connect Utility

* Timings

* Header Commands (to control connect)

    Header command sequence: SOH, byte1, byte0

    byte1: command byte, see below
    byte0: command argument byte, zero if not used

* Chip to File Transmission

    SOH, CHIP_TO_FILE_type, linetype
    STX, line data, ETX -> host replies with ACK, CAN or NAK
    STX, line data, ETX -> host replies with ACK, CAN or NAK
    STX, line data, ETX -> host replies with ACK, CAN or NAK
    [...]
    EOT

* File to Chip Transmission

    SOH, FILE_TO_CHIP_type, linetype
    STX, line data, ETX or CAN -> fw replies with ACK or NAK + error code
    STX, line data, ETX or CAN -> fw replies with ACK or NAK + error code
    STX, line data, ETX or CAN -> fw replies with ACK or NAK + error code
    [...]
    EOT

* ENUM ERRC__type



# Functions

__________
PUB  start

 Do nothing yet.


******************************************************************************
Terms of Use:

Zerocat Chipflasher is free software: you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

Zerocat Chipflasher is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License along
with Zerocat Chipflasher.  If not, see <http://www.gnu.org/licenses/>.

************************************************************** End of File ***