hellen_common.cpp File Reference

Functions
void	hellenWbo ()
void	setHellenCan ()
void	setHellenCan2 ()
static void	init5vpDiag ()
void	setHellenAnalogDividers ()
void	setHellenVbatt ()
void	setHellen64Can ()
PUBLIC_API_WEAK bool	isBoardWithPowerManagement ()
bool	getHellenBoardEnabled ()
bool	boardEnableSendWidebandInfo ()
bool	fansDisabledByBoardStatus ()
PUBLIC_API_WEAK void	onHellenEnChange (int value)
PUBLIC_API_WEAK bool	onHellenSdChange (int value)
static void	setHellenEnValue (int value)
void	hellenEnableEn (const char *msg)
void	hellenDisableEn (const char *msg)
void	hellenDisableEnSilently ()
void	setHellenEnPin (Gpio pin, bool enableBoardOnStartUp)
void	setHellenMegaEnPin (bool enableBoardOnStartUp)
void	setHellen64MegaEnPin ()
void	hellenBoardStandBy ()
void	hellenMegaSdWithAccelerometer ()
void	hellenMegaModule ()
void	hellenMegaAccelerometerPreInitCS2Pin ()
void	configureHellenCanTerminator ()
void	detectHellenBoardType ()
ObdCode	boardGetAnalogDiagnostic ()
float	getAnalogInputDividerCoefficient (adc_channel_e hwChannel)
bool	boardSdCardEnable ()

Variables
static OutputPin	megaEn
static bool	hellenEnPinInitialized = false
Timer	hellenEnPinStateChange
OutputPin	accelerometerChipSelect

Function Documentation

boardEnableSendWidebandInfo()

bool boardEnableSendWidebandInfo

(

)

Definition at line 66 of file hellen_common.cpp.

                                   {
  // when board is powered down we should be more CANbus silent
    return getHellenBoardEnabled();
}

Referenced by CanWrite::PeriodicTask().

Here is the call graph for this function:

Here is the caller graph for this function:

boardGetAnalogDiagnostic()

ObdCode boardGetAnalogDiagnostic

(

)

Definition at line 227 of file hellen_common.cpp.

{
#ifdef DIAG_5VP_PIN
    /* paranoid check */
    if (!isBrainPinValid(DIAG_5VP_PIN)) {
        /* Pin is not defined - return success */
        return ObdCode::None;
    }
 
    return efiReadPin(DIAG_5VP_PIN) ? ObdCode::None : ObdCode::OBD_ECM_VSS_OUTPUT_A_MALFUNCTION;
#else
    return ObdCode::None;
#endif
}

Referenced by boardGetAnalogInputDiagnostic().

Here is the call graph for this function:

Here is the caller graph for this function:

boardSdCardEnable()

bool boardSdCardEnable

(

)

Definition at line 266 of file hellen_common.cpp.

                         {
    // on mega-module we manage SD card power supply
    if (getHellenBoardEnabled()) {
        return true;
    }
 
    // Board can enable SD card power without enabling WBOs
    if (onHellenSdChange(1)) {
        efiPrintf("    *** turning SD power ONLY ***");
        return true;
    }
 
    if (getTimeNowS() > 4 && !isIgnVoltage()) {
        // looks like vehicle is OFF and we are hooked to USB - turn on peripheral to get Mass Storage Device USB profile
        efiPrintf("    *** turning board ON to power SD card ***");
        hellenEnableEn();
        chThdSleepMilliseconds(200);
 
        //check state
        return getHellenBoardEnabled();
    }
 
    return false;
}

Here is the call graph for this function:

configureHellenCanTerminator()

void configureHellenCanTerminator

(

)

Definition at line 211 of file hellen_common.cpp.

                                    {
    static bool initialized = false;
    static OutputPin terminatorControlPin;
    if (!initialized) {
        initialized = true;
        terminatorControlPin.initPin("CAN-term", H_SPI3_CS); // todo: make this pin configurable
        terminatorControlPin.setValue(engineConfiguration->boardUseCanTerminator);
    }
}

Referenced by hellen112_17_boardConfigOverrides(), and hellen_honda_k_boardConfigOverrides().

Here is the call graph for this function:

Here is the caller graph for this function:

detectHellenBoardType()

void detectHellenBoardType

(

)

Definition at line 221 of file hellen_common.cpp.

                             {
#ifndef EFI_BOOTLOADER
    engine->engineState.hellenBoardId = hackHellenBoardId(detectHellenBoardId());
#endif /* EFI_BOOTLOADER */
}

Referenced by detectBoardType().

Here is the call graph for this function:

Here is the caller graph for this function:

fansDisabledByBoardStatus()

bool fansDisabledByBoardStatus

(

)

Definition at line 73 of file hellen_common.cpp.

                                   {
  return !getHellenBoardEnabled();
}

Referenced by FanController::getState().

Here is the call graph for this function:

Here is the caller graph for this function:

getAnalogInputDividerCoefficient()

float getAnalogInputDividerCoefficient

(

adc_channel_e

hwChannel

)

Definition at line 242 of file hellen_common.cpp.

                                                                {
#if (HELLEN_BOARD_MM64 == TRUE)
    (void)hwChannel;
    if (0)
#endif
#if (HELLEN_BOARD_MM100 == TRUE)
    if (hwChannel == MM100_IN_CRANK_ANALOG) [[unlikely]]
#endif
#if (HELLEN_BOARD_MM144 == TRUE)
    if (hwChannel == H144_IN_CRANK_ANALOG) [[unlikely]]
#endif
#if (HELLEN_BOARD_MM176 == TRUE)
    if (hwChannel == MM176_IN_CRANK_ANALOG) [[unlikely]]
#endif
    {
        // (4.7K || 5.1K) + 4.7K divider
        // 4.7K || 5.1K == 2.445K
        return (4.7f + 2.445f) / 4.7f;
    }
 
    return engineConfiguration->analogInputDividerCoefficient;
}

getHellenBoardEnabled()

bool getHellenBoardEnabled

(

)

Definition at line 62 of file hellen_common.cpp.

                             {
  return !isBoardWithPowerManagement() || megaEn.getLogicValue();
}

Referenced by boardEnableSendWidebandInfo(), boardSdCardEnable(), fansDisabledByBoardStatus(), sendCanVerbose(), and setHwQcMode().

Here is the call graph for this function:

Here is the caller graph for this function:

hellenBoardStandBy()

void hellenBoardStandBy

(

)

Definition at line 171 of file hellen_common.cpp.

                          {
    // we need to turn 'megaEn' and pause for a bit to make sure that WBO is off and does not wake main firmware right away
    hellenDisableEn();
    // todo: 200ms is totally random what's the science for this sleep duration?
    chThdSleepMilliseconds(200);
}

Referenced by onBoardStandBy().

Here is the call graph for this function:

Here is the caller graph for this function:

hellenDisableEn()

void hellenDisableEn

(

const char *

msg

)

Definition at line 117 of file hellen_common.cpp.

                                      {
#if (EFI_FILE_LOGGING || EFI_CONFIGURATION_STORAGE) && EFI_PROD_CODE
    // un-mount before turning power off SD card
    // wait up to 1 second for SD card to become unmounted
    efiPrintf("Long poll for SD card unmount");
    int timeout = 1000;
    sdCardRequestMode(SD_MODE_UNMOUNT);
#if EFI_CONFIGURATION_STORAGE
    // safe to call, even board does not have EXT FLASH
    storagRequestUnregisterStorage(STORAGE_MFS_EXT_FLASH);
#endif // EFI_CONFIGURATION_STORAGE
    do {
        chThdSleepMilliseconds(10);
        if (sdCardGetCurrentMode() == SD_MODE_IDLE) {
            break;
        }
        timeout -= 10;
    } while (timeout > 0);
#if EFI_CONFIGURATION_STORAGE
    while (storageIsStorageRegistered(STORAGE_MFS_EXT_FLASH) && timeout > 0) {
        chThdSleepMilliseconds(10);
        timeout -= 10;
    }
#endif // EFI_CONFIGURATION_STORAGE
#endif
  efiPrintf("Turning board off [%s]", msg);
  hellenDisableEnSilently();
}

Referenced by configureRusefiLuaHooks(), and hellenBoardStandBy().

Here is the call graph for this function:

Here is the caller graph for this function:

hellenDisableEnSilently()

void hellenDisableEnSilently

(

)

Definition at line 146 of file hellen_common.cpp.

                               {
    // this function is called from criticalShutdown() that may be called from hardFault handler
    // please no call to OS functions!
    setHellenEnValue(0);
}

Referenced by hellenDisableEn(), and turnAllPinsOff().

Here is the call graph for this function:

Here is the caller graph for this function:

hellenEnableEn()

void hellenEnableEn

(

const char *

msg

)

Definition at line 108 of file hellen_common.cpp.

                                     {
  efiPrintf("Turning board ON [%s]", msg);
  setHellenEnValue(1);
#if EFI_STORAGE_MFS
  chThdSleepMilliseconds(1);
    storagRequestRegisterStorage(STORAGE_MFS_EXT_FLASH);
#endif
}

Referenced by boardSdCardEnable(), configureRusefiLuaHooks(), setHellenEnPin(), and setHwQcMode().

Here is the call graph for this function:

Here is the caller graph for this function:

hellenMegaAccelerometerPreInitCS2Pin()

void hellenMegaAccelerometerPreInitCS2Pin

(

)

Definition at line 200 of file hellen_common.cpp.

                                            {
#if EFI_ONBOARD_MEMS
    if (!accelerometerChipSelect.isInitialized()) {
        accelerometerChipSelect.initPin("mm-CS2", Gpio::H_SPI1_CS2);
        accelerometerChipSelect.setValue(1);
    }
#else
  criticalError("probably broken MEMS configuration?");
#endif // EFI_ONBOARD_MEMS
}

Referenced by hellenMegaSdWithAccelerometer(), and setMegaUaefiBoardConfigOverrides().

Here is the call graph for this function:

Here is the caller graph for this function:

hellenMegaModule()

void hellenMegaModule

(

)

Definition at line 194 of file hellen_common.cpp.

                        {
    setHellenVbatt();
    hellenMegaSdWithAccelerometer();
    setDefaultHellenAtPullUps();
}

Referenced by alphax_8chan_boardConfigOverrides(), alphax_silver_boardConfigOverrides(), alphax_silver_revA_boardConfigOverrides(), hellen154hyundai_f7_boardConfigOverrides(), and hellen_honda_k_boardConfigOverrides().

Here is the call graph for this function:

Here is the caller graph for this function:

hellenMegaSdWithAccelerometer()

void hellenMegaSdWithAccelerometer

(

)

Definition at line 188 of file hellen_common.cpp.

                                     {
        setHellenSdCardSpi1Hardware();
        // weird order of operations? i guess it does not really matter
        hellenMegaAccelerometerPreInitCS2Pin();
}

Referenced by alphax_2chan_ConfigOverrides(), alphax_4chan_ConfigOverrides(), alphax_4kgdi_boardConfigOverrides(), alphax_gold_boardConfigOverrides(), hellen112_17_boardConfigOverrides(), hellenMegaModule(), super_uaefi_boardConfigOverrides(), and uaefi_boardConfigOverrides().

Here is the call graph for this function:

Here is the caller graph for this function:

hellenWbo()

void hellenWbo

(

)

Definition at line 7 of file hellen_common.cpp.

                 {
    engineConfiguration->enableAemXSeries = true;
}

Referenced by alphax_4kgdi_defaultConfiguration(), alphax_8chan_defaultConfiguration(), alphax_8chan_reva_boardDefaultConfiguration(), hellen121_nissan_boardDefaultConfiguration(), hellen128_boardDefaultConfiguration(), hellen88_boardDefaultConfiguration(), hellen_honda_k_boardDefaultConfiguration(), hellen_MiataNB2_boardDefaultConfiguration(), super_uaefi_boardDefaultConfiguration(), and uaefi_boardDefaultConfiguration().

Here is the caller graph for this function:

init5vpDiag()

static void init5vpDiag ( )

static

Definition at line 22 of file hellen_common.cpp.

                          {
#ifdef DIAG_5VP_PIN
static bool is5vpInit = false;
  if (!is5vpInit) {
    efiSetPadMode("5VP_STATE", DIAG_5VP_PIN, PAL_MODE_INPUT);
    is5vpInit = true;
  }
#endif // DIAG_5VP_PIN
}

Referenced by setHellenVbatt().

Here is the call graph for this function:

Here is the caller graph for this function:

isBoardWithPowerManagement()

PUBLIC_API_WEAK bool isBoardWithPowerManagement

(

)

Definition at line 58 of file hellen_common.cpp.

                                                  {
  return false;
}

Referenced by FuelLevelFunc::convert(), and getHellenBoardEnabled().

Here is the caller graph for this function:

onHellenEnChange()

PUBLIC_API_WEAK void onHellenEnChange

(

int

value

)

Definition at line 77 of file hellen_common.cpp.

{ UNUSED(value); }

Referenced by setHellenEnValue().

Here is the call graph for this function:

Here is the caller graph for this function:

onHellenSdChange()

PUBLIC_API_WEAK bool onHellenSdChange

(

int

value

)

Definition at line 80 of file hellen_common.cpp.

                                                 {
    UNUSED(value);
 
    // most Hellen board have no separate SD card power control
    // return false and let MegaEn to be enabled
    return false;
}

Referenced by boardSdCardEnable().

Here is the call graph for this function:

Here is the caller graph for this function:

setHellen64Can()

void setHellen64Can

(

)

Definition at line 50 of file hellen_common.cpp.

                      {
    engineConfiguration->canTxPin = Gpio::B9;
    engineConfiguration->canRxPin = Gpio::B8;
}

Referenced by small_can_board_boardConfigOverrides().

Here is the caller graph for this function:

setHellen64MegaEnPin()

void setHellen64MegaEnPin

(

)

Definition at line 167 of file hellen_common.cpp.

                            {
    setHellenEnPin(Gpio::MM64_GP1); // OUT_PWR_EN
}

Referenced by small_can_board_boardConfigOverrides().

Here is the call graph for this function:

Here is the caller graph for this function:

setHellenAnalogDividers()

void setHellenAnalogDividers

(

)

Definition at line 32 of file hellen_common.cpp.

                               {
    // 4.7k high side/4.7k low side = 2.0 ratio divider
    engineConfiguration->analogInputDividerCoefficient = 2.0f;
 
    // set vbatt_divider 5.835
    // 33k / 6.8k
    engineConfiguration->vbattDividerCoeff = (33 + 6.8) / 6.8; // 5.835
    engineConfiguration->adcVcc = 3.3f;
}

Referenced by setHellenVbatt(), and small_can_board_boardConfigOverrides().

Here is the caller graph for this function:

setHellenCan()

void setHellenCan

(

)

Definition at line 12 of file hellen_common.cpp.

                    {
    engineConfiguration->canTxPin = H176_CAN_TX;
    engineConfiguration->canRxPin = H176_CAN_RX;
}

Referenced by alphax_2chan_ConfigOverrides(), alphax_4chan_ConfigOverrides(), alphax_4kgdi_boardConfigOverrides(), alphax_8chan_boardConfigOverrides(), alphax_8chan_reva_boardConfigOverrides(), alphax_gold_boardConfigOverrides(), alphax_silver_boardConfigOverrides(), alphax_silver_revA_boardConfigOverrides(), hellen112_17_boardConfigOverrides(), hellen121_nissan_boardDefaultConfiguration(), hellen121_vag_boardConfigOverrides(), hellen128_boardConfigOverrides(), hellen154_hyundai_boardDefaultConfiguration(), hellen154hyundai_f7_boardDefaultConfiguration(), hellen81_boardConfigOverrides(), hellen88_boardDefaultConfiguration(), hellen_gm_e67_boardConfigOverrides(), hellen_honda_k_boardDefaultConfiguration(), hellen_MiataNA6_boardConfigOverrides(), hellen_MiataNA96_boardConfigOverrides(), hellen_MiataNB1_boardConfigOverrides(), hellen_MiataNB2_boardConfigOverrides(), super_uaefi_boardConfigOverrides(), and uaefi_boardConfigOverrides().

Here is the caller graph for this function:

setHellenCan2()

void setHellenCan2

(

)

Definition at line 17 of file hellen_common.cpp.

                     {
    engineConfiguration->can2RxPin = Gpio::B12;
    engineConfiguration->can2TxPin = Gpio::B13;
}

Referenced by alphax_8chan_boardConfigOverrides(), alphax_8chan_reva_boardConfigOverrides(), uaefi_boardDefaultConfiguration(), and validateBoardConfig().

Here is the caller graph for this function:

setHellenEnPin()

void setHellenEnPin	(	Gpio	pin,
		bool	enableBoardOnStartUp
	)

Definition at line 152 of file hellen_common.cpp.

                                                         {
    if (!hellenEnPinInitialized) {
        hellenEnPinInitialized = true;
        megaEn.initPin("EN", pin);
        if (enableBoardOnStartUp) {
          hellenEnableEn("start-up");
        }
    }
}

Referenced by alphax_2chan_ConfigOverrides(), alphax_4chan_ConfigOverrides(), alphax_8chan_boardInitHardware(), alphax_8chan_reva_boardInitHardware(), setHellen64MegaEnPin(), and setHellenMegaEnPin().

Here is the call graph for this function:

Here is the caller graph for this function:

setHellenEnValue()

static void setHellenEnValue ( int  value )

static

Definition at line 92 of file hellen_common.cpp.

                                        {
  // todo: can we use 'megaEn.getLogicValue()' instead?
  static int currentHellenEnValue = -1;
 
    megaEn.setValue(value, /*isForce*/ true);
    if (currentHellenEnValue != value) {
      currentHellenEnValue = value;
#ifndef EFI_BOOTLOADER
      hellenEnPinStateChange.reset();
#endif
    }
    // todo: shall we move below callbacks into 'only-if-changed' conditional block?
    onHellenEnChange(value);
  AdcSubscription::ResetFilters();
}

Referenced by hellenDisableEnSilently(), and hellenEnableEn().

Here is the call graph for this function:

Here is the caller graph for this function:

setHellenMegaEnPin()

void setHellenMegaEnPin

(

bool

enableBoardOnStartUp

)

Definition at line 162 of file hellen_common.cpp.

                                                   {
    // H144_GP8 matches MM100_GP8 which is used as PWR_EN on early mm100
    setHellenEnPin(H144_GP8, enableBoardOnStartUp); // OUT_PWR_EN
}

Referenced by alphax_2chan_ConfigOverrides(), alphax_4chan_ConfigOverrides(), alphax_4kGDI_boardInitHardware(), alphax_gold_boardConfigOverrides(), alphax_silver_boardConfigOverrides(), alphax_silver_revA_boardConfigOverrides(), hellen112_17_boardConfigOverrides(), hellen154hyundai_f7_boardConfigOverrides(), hellen_honda_k_boardConfigOverrides(), setMegaUaefiBoardConfigOverrides(), super_uaefi_boardConfigOverrides(), and uaefi_boardConfigOverrides().

Here is the call graph for this function:

Here is the caller graph for this function:

setHellenVbatt()

void setHellenVbatt

(

)

Definition at line 42 of file hellen_common.cpp.

                      {
  setHellenAnalogDividers();
 
    engineConfiguration->vbattAdcChannel = H144_IN_VBATT;
 
  init5vpDiag(); // piggy back on popular 'setHellenVbatt' method
}

Referenced by alphax_2chan_ConfigOverrides(), alphax_4chan_ConfigOverrides(), alphax_4kgdi_boardConfigOverrides(), alphax_8chan_reva_boardConfigOverrides(), alphax_gold_boardConfigOverrides(), hellen112_17_boardConfigOverrides(), hellen121_nissan_boardConfigOverrides(), hellen121_vag_boardConfigOverrides(), hellen128_boardConfigOverrides(), hellen154_hyundai_boardConfigOverrides(), hellen81_boardConfigOverrides(), hellen88_boardConfigOverrides(), hellen_gm_e67_boardConfigOverrides(), hellen_MiataNA6_boardConfigOverrides(), hellen_MiataNA96_boardConfigOverrides(), hellen_MiataNB1_boardConfigOverrides(), hellen_MiataNB2_boardConfigOverrides(), hellenMegaModule(), setMegaUaefiBoardConfigOverrides(), super_uaefi_boardConfigOverrides(), and uaefi_boardConfigOverrides().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

accelerometerChipSelect

OutputPin accelerometerChipSelect

extern

We need to make sure that accelerometer device which physically exists does not conflict with SD card in case of shared SPI. We reply on specific order of execution here: 1) accelerometer pre-initialization into safe CS pin state 2) SD card initialization 3) accelerometer main initialization if accelerometer feature is desired

Definition at line 65 of file accelerometer.cpp.

Referenced by hellenMegaAccelerometerPreInitCS2Pin(), and initAccelerometer().

hellenEnPinInitialized

bool hellenEnPinInitialized = false

static

Definition at line 71 of file hellen_common.cpp.

Referenced by setHellenEnPin().

hellenEnPinStateChange

Timer hellenEnPinStateChange

Definition at line 89 of file hellen_common.cpp.

Referenced by FuelLevelFunc::convert(), and setHellenEnValue().

megaEn

OutputPin megaEn

static

Definition at line 55 of file hellen_common.cpp.

Referenced by getHellenBoardEnabled(), setHellenEnPin(), and setHellenEnValue().

Go to the source code of this file.