META

Supported by Ginmake 1.33 and later, GIN file version 3.23.

Used to define additional, arbitrary ‘meta’ information in the GIN file.

Ideally, this should take the format:

[META,name,other stuff..n]

Valid definitions:

CAN_CHANNEL_NAME

Gives a human readable name for the CAN channel

[META,CAN_CHANNEL_NAME,1,Vehicle CAN]
[META,CAN_CHANNEL_NAME,2,Engine CAN]

UNSECURE_PAGES

Identifies pages in the page table that can be read even when the ECU is secured.

This allows users access to some ECU areas whilst keeping other areas of the calibration locked.

[META,UNSECURE_PAGES,0]
[META,UNSECURE_PAGES,1,3,4]

Page numbers start at ZERO.

LOG_TYPE

Indicates the type of internal logging format. See GEMSCOM protocol specification for more details on the types of logs. This meta tag will affect the internal logging setup dialog.

[META,LOG_TYPE,linear]
[META,LOG_TYPE,normal]
[META,LOG_TYPE,v0.06]
[META,linear_log] - equivalent to [META,LOG_TYPE,linear]

HAS_CAN_TELE_FIXED_VALS / HAS_SERIAL_TELE_FIXED_VALS

[META,HAS_CAN_TELE_FIXED_VALS]
[META,HAS_SERIAL_TELE_FIXED_VALS]

These flags indicate that CAN telemetry and Serial Telemetry, respectively, can have ‘fixed’ values in the list of options. Fixed values insert fixed byte values into the output stream. Fixed values are identified by comcodes with the top byte set to 0x7F.

e.g. 0x7F23 instead of an actual parameter comcode would output 0x23 at the specified telemetry stream position.

By specifying these flags, GWv4 will identify fixed values and will additionally add a method for entering fixed values.

BLOB

[META,BLOB,<type>,<index>,<max_size>]; 

Identifies that there is a blob (binary large object) of a particular type. Each blob must have a unique index number (used by the protocol for reading & writing blobs) and a maximum size, in bytes. Type names prefixed ‘gems_’ are reserved and must be specified in this document.

e.g.

[META,BLOB,gems_log_setup,0,262144];

Note that blobs are required to contain the size of the data as a 4-byte little-endian integer at the start of the blob. If this value is 0 or FFFFFFFF then the blob is considered as being empty.

BLOB types

gems_log_setup Setup file for ‘full featured’ internal data logger setups.

BLOB_RW_SIZE

[META,BLOB_RW_SIZE,<[connection]>,<max_read_size>,<max_write_size>];

Indicates the maximum size that may be read/written in a single blob read/write gemscom command (see GEMSCOM protocol specification document).

The size identified is the maximum number of bytes that may be in the data portion of the command, excluding the command header/checksum overhead.

The may indicate a specific connection type that this applies to (e.g. COM or FTDI) or it may be left blank as a global setting.

HAS_COPROCESSOR_ISP

Indicates that coprocessor firmware can be uploaded to this ECU.

Note that the coprocessor .bin file must contain a string that says:

“GEMS FIRMWARE”, followed by the name/version of the firmware which will be presented to the user.

COPRO_BOOTLOADER

Indicates that this GIN file is for a CoPro bootloader firmware image.

Alternatively, if the ECU name ends with ‘CPB’ then the GIN is considered as being CoPro bootloader.

MIN_COPRO_VERSION

Indicates that this product has a minimum CoPro firmware version recommendation. This is not a hard requirement but GW may indicate to the user that an upgrade of the CoPro firmware is recommended.

COMMS_READ_OPTIMIZE / COMMS_WRITE_OPTIMIZE

Set to ‘1’ to explicitly enable comms read/write optimizations. Set to ‘0’ to disable them.

Some ECUs have bugs that mean that joining adjacent reads together to reduce bandwidth can result in incorrect data being read from the ECU due to the CoPro using internal byte-swapping.

This was fixed in EM80_M but there are many versions of EM80/GDI80 CoPro etc in the field that have this bug.

GWv4 will automatically disable read optimizations on EM80, GDI80 unless the CoPro version is >= 02x01.

Affected ECUs:

  • EM80
  • EM80 CAP
  • EM80 WRX
  • EM80aero
  • EM80S
  • EM80SAAB
  • RX80
  • GDi80
  • WEAF30
  • Adapt
  • EM112
  • EM154

For new ECUs that use lower versioned CoPro that does not have this issue, explicitly set COMMS_READ_OPTIMIZE / COMMS_WRITE_OPTIMIZE to ‘1’ in the GIN file.

ECU_CALIBRATION_OFFSET

Ginmake 2.39+. When exporting A2L format ECU definition file, this inserts ECU_ CALIBRATION_OFFSET into the MOD_PAR section.

EPK

Ginmake 2.39+. When exporting A2L format ECU definition file, this inserts EPK into the MOD_PAR section.

e.g.

[META,EPK,{REV_NAME}{REV_VERSION}]

EPK_ADDR

Ginmake 2.39+. When exporting A2L format ECU definition file, this inserts ADDR_EPK into the MOD_PAR section.

There is an alternative to using this META string and that is to define an EPK ECU_STRING. If defined, the address of the EPK ECU_STRING object shall be used.

NO_CLEAR_BEFORE_REFLASH

If defined, causes GEMS Reflash tool to disable the ‘clear’ calibration option for this ECU & not perform a pre-clear.

REFLASH_RESETS_CAL

Indicates that a reflash of the firmware will reset the calibration to default values. May simplify the user-interface flow when reflashing + reprogramming ECUs.

MODULE_VERSION

A2L: Populates Version field of MOD_PAR section in A2L file.

MODULE_NAME

A2L: Populates name of MODULE in A2L file. If not specified the ECU name is used (i.e. REV_NAME).

MODULE_LONG_IDENTIFIER

A2L: Populates long identifier field of MODULE in A2L file. If not specified, the generated ECU Identity display name / version (REV_VERSION or Virtual Version) is used.