Exported Types & added comments

Author: asap2Go

a2l/axis_pts_4.go

@@ -16,7 +16,7 @@ type AxisPts4 struct {
 	DatatypeSet   bool
 	IndexIncr     indexOrderEnum
 	IndexIncrSet  bool
-	Addressing    addrTypeEnum
+	Addressing    AddrTypeEnum
 	AddressingSet bool
 	Values        interface{}
 	ValuesSet     bool

a2l/axis_pts_5.go

@@ -16,7 +16,7 @@ type AxisPts5 struct {
 	DatatypeSet   bool
 	IndexIncr     indexOrderEnum
 	IndexIncrSet  bool
-	Addressing    addrTypeEnum
+	Addressing    AddrTypeEnum
 	AddressingSet bool
 	Values        interface{}
 	ValuesSet     bool

a2l/axis_pts_x.go

@@ -16,7 +16,7 @@ type AxisPtsX struct {
 	DatatypeSet   bool
 	IndexIncr     indexOrderEnum
 	IndexIncrSet  bool
-	Addressing    addrTypeEnum
+	Addressing    AddrTypeEnum
 	AddressingSet bool
 	Values        interface{}
 	ValuesSet     bool

a2l/axis_pts_y.go

@@ -16,7 +16,7 @@ type AxisPtsY struct {
 	DatatypeSet   bool
 	IndexIncr     indexOrderEnum
 	IndexIncrSet  bool
-	Addressing    addrTypeEnum
+	Addressing    AddrTypeEnum
 	AddressingSet bool
 	Values        interface{}
 	ValuesSet     bool

a2l/axis_pts_z.go

@@ -16,7 +16,7 @@ type AxisPtsZ struct {
 	DatatypeSet   bool
 	IndexIncr     indexOrderEnum
 	IndexIncrSet  bool
-	Addressing    addrTypeEnum
+	Addressing    AddrTypeEnum
 	AddressingSet bool
 	Values        interface{}
 	ValuesSet     bool

a2l/axis_rescale_x.go

@@ -63,7 +63,7 @@ type AxisRescaleX struct {
 	MaxNumberOfRescalePairsSet bool
 	IndexIncr                  indexOrderEnum
 	IndexIncrSet               bool
-	Adressing                  addrTypeEnum
+	Adressing                  AddrTypeEnum
 	AdressingSet               bool
 }
 

a2l/blob.go

@@ -7,8 +7,8 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
-//Specification of a binary blob object which has no further semantic interpretation in the MCD system.
-//It is just an array of bytes without a conversion method or special record layout.
+// Specification of a binary blob object which has no further semantic interpretation in the MCD system.
+// It is just an array of bytes without a conversion method or special record layout.
 type blob struct {
 	name                string
 	nameSet             bool
@@ -18,7 +18,7 @@ type blob struct {
 	addressSet          bool
 	size                uint32
 	sizeSet             bool
-	addressType         addrTypeEnum
+	addressType         AddrTypeEnum
 	addressTypeSet      bool
 	annotation          []annotation
 	calibrationAccess   calibrationAccessEnum

a2l/ecu_address_extension.go

@@ -7,6 +7,16 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
+/*
+This keyword is used to specify additional address information. For instance it can be
+used, to distinguish different address spaces of an ECU (multi-micro controller devices).
+ECU_ADDRESS_EXTENSION is an optional keyword of MEASUREMENT, AXIS_PTS
+and CHARACTERISTIC.
+Some calibration interfaces, such as CCP and XCP need an address extension to
+access ECU data. To avoid the need for additional IF_DATA section at calibration
+and measurement objects, the keyword ECU_ADDRESS_EXTENSION has been
+introduced
+*/
 type ecuAddressExtension struct {
 	extension    int16
 	extensionSet bool

a2l/ecu_calibration_offset.go

@@ -6,6 +6,16 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
+/*
+ECU_CALIBRATION_OFFSET is used to describe a fixed address offset when accessing
+characteristics in the control unit due to
+-near pointers in calibration objects. Some record layouts include near pointers
+inside a calibration objects from which the calibration system has to compute the
+absolute values by adding the ECU_CALIBRATION_OFFSET (CDAMOS)
+-variant coding. Some ECU projects include multiple data sets for different engine or
+vehicle projects served by one common ECU. By using the
+ECU_CALIBRATION_OFFSET, a selection for project base address can be made
+*/
 type ecuCalibrationOffset struct {
 	offset    string
 	offsetSet bool

a2l/enums.go

@@ -236,23 +236,23 @@ func parseDataSizeEnum(tok *tokenGenerator) (DataSizeEnum, error) {
 	return d, err
 }
 
-// addrTypeEnum defines which address width is necessary.
-type addrTypeEnum string
+// AddrTypeEnum defines which address width is necessary.
+type AddrTypeEnum string
 
 const (
-	undefinedAddrtype addrTypeEnum = emptyToken
-	PBYTE             addrTypeEnum = pbyteToken
-	PWORD             addrTypeEnum = pwordToken
-	PLONG             addrTypeEnum = plongToken
-	PLONGLONG         addrTypeEnum = plonLongToken
+	undefinedAddrtype AddrTypeEnum = emptyToken
+	PBYTE             AddrTypeEnum = pbyteToken
+	PWORD             AddrTypeEnum = pwordToken
+	PLONG             AddrTypeEnum = plongToken
+	PLONGLONG         AddrTypeEnum = plonLongToken
 	/*DIRECT: If an adjustable or measurable object is defined with indirect addressing
 	(ADDRESS_TYPE is not DIRECT) and if the used interface does not support indirect
 	addressing, it is the responsibility of the MC-System to dereference the object’s
 	address before accessing the data or configuring measurement lists.*/
-	DIRECT addrTypeEnum = directToken
+	DIRECT AddrTypeEnum = directToken
 )
 
-func parseAddrTypeEnum(tok *tokenGenerator) (addrTypeEnum, error) {
+func parseAddrTypeEnum(tok *tokenGenerator) (AddrTypeEnum, error) {
 	a := undefinedAddrtype
 	var err error
 	switch tok.current() {
@@ -304,6 +304,25 @@ func parseByteOrderEnum(tok *tokenGenerator) (ByteOrderEnum, error) {
 	return b, err
 }
 
+func (boe *ByteOrderEnum) String() string {
+	switch *boe {
+	case LittleEndian:
+		return littleEndianToken
+	case BigEndian:
+		return bigEndianToken
+	case MsbLast:
+		return msbLastToken
+	case MsbFirst:
+		return msbFirstToken
+	case MsbFirstMswLast:
+		return msbFirstMswLastToken
+	case MsbLastMswFirst:
+		return msbLastMswFirstToken
+	default:
+		return emptyToken
+	}
+}
+
 type indexOrderEnum string
 
 const (

a2l/fnc_values.go

@@ -29,9 +29,11 @@ type FncValues struct {
 			to this table value or axis point value.
 	PLONG:	The relevant memory location has a 4 byte pointer
 			to this table value or axis point value.
+	PLONGLONG:	The relevant memory location has a 8 byte pointer
+			to this table value or axis point value.
 	DIRECT:	The relevant memory location has the first table value
 			or axis point value, all others follow with incrementing address. */
-	Addresstype    addrTypeEnum
+	Addresstype    AddrTypeEnum
 	AddresstypeSet bool
 }
 

a2l/instance.go

@@ -15,7 +15,7 @@ type instance struct {
 	typeDefNameSet      bool
 	address             string
 	addressSet          bool
-	addressType         addrTypeEnum
+	addressType         AddrTypeEnum
 	annotation          []annotation
 	calibrationAccess   calibrationAccessEnum
 	displayIdentifier   DisplayIdentifier

a2l/structure_component.go

@@ -13,7 +13,7 @@ type structureComponent struct {
 	typeDefNameSet   bool
 	addressOffset    string //uint32
 	addressOffsetSet bool
-	addressType      addrTypeEnum
+	addressType      AddrTypeEnum
 	layout           layout
 	matrixDim        MatrixDim
 	symbolTypeLink   symbolTypeLink

a2l/type_def_blob.go

@@ -14,7 +14,7 @@ type typeDefBlob struct {
 	longIdentifierSet bool
 	size              uint32
 	sizeSet           bool
-	addressType       addrTypeEnum
+	addressType       AddrTypeEnum
 }
 
 func parseTypeDefBlob(tok *tokenGenerator) (typeDefBlob, error) {

a2l/type_def_structure.go

@@ -14,7 +14,7 @@ type typeDefStructure struct {
 	longIdentifierSet  bool
 	size               uint32
 	sizeSet            bool
-	addressType        addrTypeEnum
+	addressType        AddrTypeEnum
 	consistentExchange consistentExchangeKeyword
 	structureComponent []structureComponent
 	symbolTypeLink     symbolTypeLink

calib_data.go

@@ -18,7 +18,6 @@ import (
 	"time"
 
 	"github.com/asap2Go/calibrationReader/a2l"
-	"github.com/x448/float16"
 
 	"github.com/asap2Go/calibrationReader/ihex32"
 
@@ -41,11 +40,6 @@ type CalibrationData struct {
 	Hex map[uint32]byte
 }
 
-// Numeric is used to define all number types used within the generic functions in this module
-type Numeric interface {
-	uint8 | int8 | uint16 | int16 | uint32 | int32 | uint64 | int64 | float16.Float16 | float32 | float64
-}
-
 // ReadCalibration takes filepaths to the a2l file and the hex file,
 // parses them in parallel and returns a CalibrationData struct
 func ReadCalibration(a2lFilePath string, hexFilePath string) (CalibrationData, error) {
@@ -483,7 +477,7 @@ func (cd *CalibrationData) getNextAlignedAddress(address uint32, dte a2l.DataTyp
 	}
 }
 
-// getBytes gets a number of bites (length) from a given address and returns a byte slice
+// getBytes gets a number of bytes (length) from a given address and returns a byte slice
 // if the address cannot be found an error is returned
 func (cd *CalibrationData) getBytes(address uint32, length uint32) ([]byte, error) {
 	nBytes := length / 8
@@ -505,19 +499,8 @@ func (cd *CalibrationData) getBytes(address uint32, length uint32) ([]byte, erro
 	return bytes, nil
 }
 
-// GetAllValuesFromHex Reads all values for each characteristic and its corresponding record layout from the hex file and converts it to decimal, and physical values.
-func (cd *CalibrationData) GetAllValuesFromHex() error {
-	//for each characteristic get its record layout:
-	for _, c := range cd.A2l.Project.Modules[cd.ModuleIndex].Characteristics {
-		var cv CharacteristicValues
-		cv.characteristic = &c
-		cd.getValuesFromHex(&cv)
-	}
-	return nil
-}
-
 // getValuesFromHex Reads all values for ONE specific characteristic and its corresponding record layout from the hex file and converts it to decimal, and physical values.
-func (cd *CalibrationData) getValuesFromHex(cv *CharacteristicValues) {
+func getValuesFromHex(cv *CharacteristicValues, cd *CalibrationData) {
 	rl, err := cd.getRecordLayout(cv.characteristic)
 	if err != nil {
 		log.Err(err).Msg("record layout for identifier '" + cv.characteristic.Deposit + "' not found")
@@ -596,8 +579,10 @@ func (cd *CalibrationData) getValuesFromHex(cv *CharacteristicValues) {
 				log.Err(err).Msg("could not get value for distOp5 of characteristic '" + cv.characteristic.Name + "'")
 			}
 		case "FncValues":
-			//interesting part
-
+			cv.fncValues, err = cd.getFncValues(rl, &curPos)
+			if err != nil {
+				log.Err(err).Msg("could not get value for fncValues of characteristic '" + cv.characteristic.Name + "'")
+			}
 		case "Identification":
 			cv.identificationValue, err = cd.getIdentification(rl, &curPos)
 			if err != nil {
@@ -666,26 +651,27 @@ func (cd *CalibrationData) getValuesFromHex(cv *CharacteristicValues) {
 		/*RIP_ADDR_X-Y-Z-4-5-W
 		are only used to store interpolation results,
 		so they are not read from hex as there is nothing to read
-		*/
 		case "RipAddrW":
 		case "RipAddrX":
 		case "RipAddrY":
 		case "RipAddrZ":
 		case "RipAddr4":
 		case "RipAddr5":
+
 		/*SRC_ADDR_X-Y-Z-4-5
 		define a input quantity meaning a measurement that determines which point of an axis is chosen for reading a value from a given characteristic.
 		e.g. given a curve where the x-Axis is the rpm of the engine and the values are
 		a defined relative engine load:
 		x	1000	2000	3000	4000	5000	6000
 		v	  12	  27	  38	  42	  49	  18
 		then  if the input quantity for this curve would be the measurement of the current rpm of the engine
-		depending on the rpm a value is chosen.*/
+		depending on the rpm a value is chosen.
 		case "SrcAddrX":
 		case "SrcAddrY":
 		case "SrcAddrZ":
 		case "SrcAddr4":
 		case "SrcAddr5":
+		*/
 		case "ShiftOpX":
 			cv.shiftOpXValue, err = cd.getShiftOpX(rl, &curPos)
 			if err != nil {
@@ -729,10 +715,55 @@ func (cd *CalibrationData) getValue(curPos *uint32, dte a2l.DataTypeEnum, rl *a2
 	return bytes, nil
 }
 
-func convertNumericToInt[num Numeric](n num) int64 {
-	return int64(n)
-}
-
-func convertNumericToFloat[num Numeric](n num) float64 {
-	return float64(n)
+func (cd *CalibrationData) getFncValues(rl *a2l.RecordLayout, curPos *uint32, cv *CharacteristicValues) (interface{}, error) {
+	//check access type. DIRECT is the most used. Just read value from a given address.
+	//in case other access types are set this gets more complicated as either offsets or pointers are leveraged to
+	//define the position of the calibration objects.
+	//for VALUE Type: just read one value at curPos
+	//for higher level objects: read the number of elements defined by the matrix dim or NoAxisPts fields with the direction (row, column, alternate, ...) specified.
+	//for applicable objects check whether STATIC_RECORD_LAYOUT and STATIC_ ADDRESS_OFFSET are set
+	//to determine how to read the FNC_Values correctly, this can lead to hard to detect errors when not implemented.
+	//for now just read the values as they are defined in the A2L file.
+	if !rl.FncValues.AddresstypeSet {
+		rl.FncValues.Addresstype = a2l.DIRECT
+	}
+	switch rl.FncValues.Addresstype {
+	case a2l.DIRECT:
+		valBytes, err := cd.getValue(curPos, a2l.UBYTE, rl)
+		if err != nil {
+			log.Err(err).Msg("could not get byte of new adress for fncValues of characteristic '" + cv.characteristic.Name + "'")
+			return nil, err
+		}
+		val, err := cd.convertByteSliceToDatatype(valBytes, a2l.UBYTE)
+		if err != nil {
+			log.Err(err).Msg("could not get adress from new adress bytes for fncValues of characteristic '" + cv.characteristic.Name + "'")
+			return nil, err
+		}
+		log.Info().Msg(strconv.FormatFloat(val, 'f', 0, 64))
+	case a2l.PBYTE:
+		newAdressBytes, err := cd.getValue(curPos, a2l.UBYTE, rl)
+		if err != nil {
+			log.Err(err).Msg("could not get byte of new adress for fncValues of characteristic '" + cv.characteristic.Name + "'")
+			return nil, err
+		}
+		newAdress, err := cd.convertByteSliceToDatatype(newAdressBytes, a2l.UBYTE)
+		if err != nil {
+			log.Err(err).Msg("could not get adress from new adress bytes for fncValues of characteristic '" + cv.characteristic.Name + "'")
+			return nil, err
+		}
+		log.Info().Msg(strconv.FormatFloat(newAdress, 'f', 0, 64))
+		//the address contains an one byte pointer to the first axis point or value
+	case a2l.PWORD:
+		//the address contains an two byte pointer to the first axis point or value
+	case a2l.PLONG:
+		//the address contains an four byte pointer to the first axis point or value
+	case a2l.PLONGLONG:
+		//the address contains an eight byte pointer to the first axis point or value
+	default:
+		//no valid address type
+		err := errors.New("invalid address type for fncValues")
+		log.Err(err).Msg("invalid address type for fncValues of characteristic '" + cv.characteristic.Name + "'")
+		return nil, err
+	}
+	return nil, nil
 }