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

../../firmware2/src/linespec.spin.terminal.html

Propeller Spin/PASM Compiler 'OpenSpin' (c)2012-2016 Parallax Inc. DBA Parallax Semiconductor.
Version 1.00.78
Compiling...
../../firmware2/src/linespec.spin
|-blocksizes.spin
Done.
Program size is 340 bytes

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

Copyright (C) 2020, 2021, 2022  Kai Mertens 

File linespec.spin --- i/o line specifications

This file is part of Zerocat Chipflasher.

See end of file for terms of use.

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


# Interface Description

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

PUB  init
PUB  toggle_index
PUB  get_type : 
PUB  get_mode0xff : 
PUB  set_mode0xff(mode)
PUB  trim_payload_MotS(load, addr) : 
PUB  get_payload(addr) : 
PUB  getptr_typename : 
PUB  inc_payload
PUB  getptr_HEADSTR_PREFIX : 

Program:  81 Longs
Variable: 1 Longs


# Loaded Objects

* Flash Block Sizes


# Constants

* Struct LINESPEC (See DAT Block)
    - LINESPEC Array Size
    - LINESPEC Record Size
    - LINESPEC Member Offsets
* ENUM TYPE_type
* Mode Bits
    - Mode Bit: Split Line into Lines of Data and $FF
    - Mode Bit: Strip Line of Pure $FF Data
    - Mode Flags: Inline $FF Runlength
* Default Mode Settings for Hexdump Line
* Default Mode Settings for Motorola-S Line
* Buffer Sizes
    - Line Buffer Size
    - Line Data Buffer Size
* Frame Sizes
    - Line Overhead for a Header Line (Any Type)
    - Overhead Size for a Motorola-S Line
    - Overhead Size for a Hexdump Line
    - Maximal Size of Header String
Payload Sizes
    - Base Payload Size
    - Maximal Payload for a Hex-Dump Line
    - Default Payload HEXD
    - Maximal Payload for a Motorola-S Line
    - Default Payload SREC


# Globals



# Functions

_________
PUB  init

 Initialize variables.

_________________
PUB  toggle_index

 Toggle index, thus switch between Motorola and Hexdump Line Format.

________________
PUB  get_type : 

 Return type of active LINESPEC record.

____________________
PUB  get_mode0xff : 

 Return mode_0xff of active LINESPEC record.

_______________________
PUB  set_mode0xff(mode)

 Set mode_0xff of active LINESPEC record.

_____________________________________
PUB  trim_payload_MotS(load, addr) : 

 Adjust payload.

_________________________
PUB  get_payload(addr) : 

 Return payload of active LINESPEC record.

_______________________
PUB  getptr_typename : 

 Return pointer to start of LINESPEC name string.

________________
PUB  inc_payload


_____________________________
PUB  getptr_HEADSTR_PREFIX : 

 Return address of string HEADSTR_PREFIX.


# Data

* String HEADSTR_PREFIX
* Struct LINESPEC: Line Specifications


******************************************************************************
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 ***