#include <hip9011_logic.h>

Collaboration diagram for HIP9011:

[legend]

Public Member Functions
	HIP9011 (Hip9011HardwareInterface *hardware)

int	sendCommand (uint8_t cmd)

int	sendCommandGetReply (uint8_t cmd, uint8_t *reply)

float	getRpmByAngleWindowAndTimeUs (int timeUs, float angleWindowWidth)

void	prepareRpmLookup (void)

void	setAngleWindowWidth (DEFINE_HIP_PARAMS)

void	handleSettings (int rpm DEFINE_PARAM_SUFFIX(DEFINE_HIP_PARAMS))

int	cylinderToChannelIdx (int cylinder)

int	handleChannel (DEFINE_HIP_PARAMS)

int	readValueAndHandleChannel (DEFINE_HIP_PARAMS)

float	getBand (DEFINE_HIP_PARAMS)

int	getIntegrationIndexByRpm (float rpm)

int	getIntegrationTimeByIndex (int index)

int	getBandIndex (DEFINE_HIP_PARAMS)

int	getGainIndex (DEFINE_HIP_PARAMS)

Data Fields
uint8_t	intergratorIdx = 0xff

uint8_t	bandIdx = 0xff

uint8_t	prescaler = 0xff

uint8_t	gainIdx = 0xff

uint8_t	channelIdx = 0xff

float	angleWindowWidth = - 1

Hip9011HardwareInterface *	hw

bool	adv_mode = false

hip_state_e	state

int8_t	cylinderNumber = -1

int8_t	expectedCylinderNumber = -1

uint16_t	rawValue [HIP_INPUT_CHANNELS]

uint16_t	rpmLookup [INT_LOOKUP_SIZE]

efitick_t	knockSampleTimestamp = 0

int	correctResponsesCount = 0

int	invalidResponsesCount = 0

int	samples = 0

int	overrun = 0

int	unsync = 0

Detailed Description

Definition at line 80 of file hip9011_logic.h.

Constructor & Destructor Documentation

◆ HIP9011()

HIP9011::HIP9011 ( Hip9011HardwareInterface * hardware )

explicit

Definition at line 64 of file hip9011_logic.cpp.

                                                   {
    this->hw = hardware;
}

Member Function Documentation

◆ cylinderToChannelIdx()

int HIP9011::cylinderToChannelIdx ( int cylinder )

Definition at line 191 of file hip9011_logic.cpp.

                                              {
    /* TODO: hip9011 inputs to bank mapping? */
    return getCylinderKnockBank(cylinder);
}

Referenced by handleChannel(), and readValueAndHandleChannel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBand()

float HIP9011::getBand ( DEFINE_HIP_PARAMS )

Returns: frequency band we are interested in

Definition at line 79 of file hip9011_logic.cpp.

                                        {
    return bore2frequency(GET_CONFIG_VALUE(cylinderBore));
}

Referenced by getBandIndex(), and showHipInfo().

Here is the caller graph for this function:

◆ getBandIndex()

int HIP9011::getBandIndex ( DEFINE_HIP_PARAMS )

Definition at line 83 of file hip9011_logic.cpp.

                                           {
    float freq = getBand(FORWARD_HIP_PARAMS);
    int i = findIndexMsg("freq", bandFreqLookup, BAND_LOOKUP_SIZE, freq);
    if (i < 0)
        i = 0;
    if (i > BAND_LOOKUP_SIZE - 1)
        i = BAND_LOOKUP_SIZE - 1;
 
    return i;
}

Referenced by handleSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGainIndex()

int HIP9011::getGainIndex ( DEFINE_HIP_PARAMS )

Definition at line 94 of file hip9011_logic.cpp.

                                           {
    int i = findIndexMsg("fGain", gainLookupInReverseOrder, GAIN_LOOKUP_SIZE, GET_CONFIG_VALUE(hip9011Gain));
    if (i < 0)
        i = 0;
    if (i > GAIN_LOOKUP_SIZE - 1)
        i = GAIN_LOOKUP_SIZE - 1;
 
    /* reverse order */
    return GAIN_LOOKUP_SIZE - 1 - i;
}

Referenced by handleSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIntegrationIndexByRpm()

int HIP9011::getIntegrationIndexByRpm ( float rpm )

Definition at line 135 of file hip9011_logic.cpp.

                                               {
    int i = findIndexMsg("getIbR", rpmLookup, INT_LOOKUP_SIZE, (uint16_t)(rpm));
    return i == -1 ? INT_LOOKUP_SIZE - 1 : INT_LOOKUP_SIZE - i - 1;
}

Referenced by handleSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIntegrationTimeByIndex()

int HIP9011::getIntegrationTimeByIndex ( int index )

Definition at line 140 of file hip9011_logic.cpp.

                                                {
    return integratorValues[index & 0x1f];
}

Referenced by showHipInfo().

Here is the caller graph for this function:

◆ getRpmByAngleWindowAndTimeUs()

float HIP9011::getRpmByAngleWindowAndTimeUs	(	int	timeUs,
		float	p_angleWindowWidth
	)

'TC is typically TINT/(2*Pi*VOUT)' Knock Sensor Training TPIC8101, page 24

TINT = TC * 2 * PI * VOUT

rpm = 60 seconds / time '60000000' because revolutions per MINUTE in uS conversion

Definition at line 109 of file hip9011_logic.cpp.

                                                                                {
    /**
     * TINT = TC * 2 * PI * VOUT
     */
    float integrationTimeUs = timeUs * 2 * CONST_PI * HIP9011_ANALOG_OUTPUT_MAX;
    /**
     * rpm = 60 seconds / time
     * '60000000' because revolutions per MINUTE in uS conversion
     */
    float windowWidthMult = p_angleWindowWidth / 360.0f;
    return (60.0f * 1000.0f * 1000.0f) / integrationTimeUs * windowWidthMult;
}

Referenced by prepareRpmLookup().

Here is the caller graph for this function:

◆ handleChannel()

int HIP9011::handleChannel ( DEFINE_HIP_PARAMS )

Definition at line 196 of file hip9011_logic.cpp.

                                            {
    int ret;
 
    /* we did not receive any callback from spark logic with valid cylinder yet */
    if (cylinderNumber < 0)
        return -1;
 
    /* find next firing cylinder */
    /* MAGIC +1 -1, couse getNextFiringCylinderId expect cylinders to start from 1 */
    expectedCylinderNumber = getNextFiringCylinderId((cylinderNumber + 1)) - 1;
 
    int nextChannelIdx = cylinderToChannelIdx(expectedCylinderNumber);
    if (nextChannelIdx == channelIdx)
        return 0;
 
    ret = sendCommand(SET_CHANNEL_CMD(nextChannelIdx));
    if (ret)
        return ret;
 
    channelIdx = nextChannelIdx;
 
    return 0;
}

Referenced by hipThread().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleSettings()

void HIP9011::handleSettings ( int rpm DEFINE_PARAM_SUFFIXDEFINE_HIP_PARAMS )

Definition at line 159 of file hip9011_logic.cpp.

                                                                           {
    int ret;
 
    setAngleWindowWidth(FORWARD_HIP_PARAMS);
 
    uint8_t new_prescaler = GET_CONFIG_VALUE(hip9011Prescaler);
    uint8_t new_integratorIdx = getIntegrationIndexByRpm(rpm);
    uint8_t new_gainIdx = getGainIndex(FORWARD_HIP_PARAMS);
    uint8_t new_bandIdx = getBandIndex(FORWARD_HIP_PARAMS);
 
    if (gainIdx != new_gainIdx) {
        ret = sendCommand(SET_GAIN_CMD(new_gainIdx));
        if (ret == 0)
            gainIdx = new_gainIdx;
    }
    if (intergratorIdx != new_integratorIdx) {
        ret = sendCommand(SET_INTEGRATOR_CMD(new_integratorIdx));
        if (ret == 0)
            intergratorIdx = new_integratorIdx;
    }
    if (bandIdx != new_bandIdx) {
        ret = sendCommand(SET_BAND_PASS_CMD(new_bandIdx));
        if (ret == 0)
            bandIdx = new_bandIdx;
    }
    if (prescaler != new_prescaler) {
        ret = sendCommand(SET_PRESCALER_CMD(new_prescaler));
        if (ret == 0)
            prescaler = new_prescaler;
    }
}

Referenced by hipThread().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareRpmLookup()

void HIP9011::prepareRpmLookup ( void )

We know the set of possible integration times, we know the knock detection window width

out binary search method needs increasing order thus the reverse order here

Definition at line 126 of file hip9011_logic.cpp.

                                   {
    /**
     * out binary search method needs increasing order thus the reverse order here
     */
    for (int i = 0; i < INT_LOOKUP_SIZE; i++) {
        rpmLookup[i] = getRpmByAngleWindowAndTimeUs(integratorValues[INT_LOOKUP_SIZE - i - 1], angleWindowWidth);
    }
}

Referenced by setAngleWindowWidth().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readValueAndHandleChannel()

int HIP9011::readValueAndHandleChannel ( DEFINE_HIP_PARAMS )

Definition at line 220 of file hip9011_logic.cpp.

                                                        {
    int ret;
    uint8_t rx[2];
 
    /* we did not receive any callback from spark logic with valid cylinder yet */
    if (cylinderNumber < 0)
        return -1;
 
    /* find next firing cylinder */
    /* MAGIC +1 -1, couse getNextFiringCylinderId expect cylinders to start from 1 */
    expectedCylinderNumber = getNextFiringCylinderId((cylinderNumber + 1)) - 1;
 
    int nextChannelIdx = cylinderToChannelIdx(expectedCylinderNumber);
 
    /* use cached values, let handleSettings take care of settings update */
    /* don't care about rx'ed data now */
    ret = sendCommand(SET_PRESCALER_CMD(prescaler));
    if (ret)
        return ret;
 
    /* reply from Set Prescaler CMD -> D7 to D0 of the digital integrator output */
    ret = sendCommandGetReply(SET_CHANNEL_CMD(nextChannelIdx), &rx[0]);
    if (ret)
        return ret;
 
    /* Same connand to get reply for previous command:
     * reply from Select the channel CMD -> D9 to D8 of difital integrator output and six zeroes */
    ret = sendCommandGetReply(SET_CHANNEL_CMD(nextChannelIdx), &rx[1]);
    if (ret)
        return ret;
 
    channelIdx = nextChannelIdx;
 
    /* D9..D8 in high bits */
    rx[1] = (rx[1] >> 6) & 0x03;
 
    /* return digital integrator value */
    return (rx[0] | (rx[1]  << 8));
}

Referenced by hipThread().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendCommand()

int HIP9011::sendCommand ( uint8_t cmd )

Definition at line 68 of file hip9011_logic.cpp.

                                    {
    return hw->sendSyncCommand(cmd, NULL);
}

Referenced by handleChannel(), handleSettings(), and readValueAndHandleChannel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendCommandGetReply()

int HIP9011::sendCommandGetReply	(	uint8_t	cmd,
		uint8_t *	reply
	)

Definition at line 72 of file hip9011_logic.cpp.

                                                            {
    return hw->sendSyncCommand(cmd, reply);
}

Referenced by readValueAndHandleChannel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAngleWindowWidth()

void HIP9011::setAngleWindowWidth ( DEFINE_HIP_PARAMS )

Definition at line 144 of file hip9011_logic.cpp.

                                                   {
    float new_angleWindowWidth = GET_CONFIG_VALUE(knockSamplingDuration);
    if (new_angleWindowWidth < 0) {
#if EFI_PROD_CODE
        warning(ObdCode::CUSTOM_KNOCK_WINDOW, "invalid knock window");
#endif
        new_angleWindowWidth = 0;
    }
    // float '==' is totally appropriate here
    if (angleWindowWidth == new_angleWindowWidth)
        return; // exit if value has not change
    angleWindowWidth = new_angleWindowWidth;
    prepareRpmLookup();
}