hardware.h File Reference

Functions
void	startHardware ()
void	stopHardware ()
SPIDriver *	getSpiDevice (spi_device_e spiDevice)
void	turnOnSpi (spi_device_e device)
void	lockSpi (spi_device_e device)
void	unlockSpi (spi_device_e device)
brain_pin_e	getMisoPin (spi_device_e device)
brain_pin_e	getMosiPin (spi_device_e device)
brain_pin_e	getSckPin (spi_device_e device)
void	printSpiConfig (const char *msg, spi_device_e device)
void	onFastAdcComplete (adcsample_t *)
void	applyNewHardwareSettings ()
void	initHardwareNoConfig ()
void	initHardware ()
void	setBor (int borValue)

Function Documentation

applyNewHardwareSettings()

void applyNewHardwareSettings

(

)

this method is NOT currently invoked on ECU start todo: reduce code duplication by moving more logic into startHardware method

All 'stop' methods need to go before we begin starting pins.

We take settings from 'activeConfiguration' not 'engineConfiguration' while stopping hardware. Some hardware is restart unconditionally on change of parameters while for some systems we make extra effort and restart only relevant settings were changes.

Definition at line 314 of file hardware.cpp.

                                {
    /**
     * All 'stop' methods need to go before we begin starting pins.
     *
     * We take settings from 'activeConfiguration' not 'engineConfiguration' while stopping hardware.
     * Some hardware is restart unconditionally on change of parameters while for some systems we make extra effort and restart only
     * relevant settings were changes.
     *
     */
    ButtonDebounce::stopConfigurationList();
 
#if EFI_PROD_CODE
    stopSensors();
#endif // EFI_PROD_CODE
 
#if EFI_PROD_CODE && EFI_SHAFT_POSITION_INPUT
    stopTriggerInputPins();
#endif /* EFI_SHAFT_POSITION_INPUT */
 
#if EFI_PROD_CODE && EFI_SENT_SUPPORT
    stopSent();
#endif // EFI_SENT_SUPPORT
 
#if EFI_CAN_SUPPORT
    stopCanPins();
#endif /* EFI_CAN_SUPPORT */
 
    stopKLine();
 
 
    stopHardware();
 
#if HAL_USE_SPI
    stopSpiModules();
#endif /* HAL_USE_SPI */
 
    if (isPinOrModeChanged(clutchUpPin, clutchUpPinMode)) {
        // bug? duplication with stopSwitchPins?
        efiSetPadUnused(activeConfiguration.clutchUpPin);
    }
 
    enginePins.unregisterPins();
 
#if EFI_PROD_CODE
    reconfigureSensors();
#endif /* EFI_PROD_CODE */
 
    ButtonDebounce::startConfigurationList();
 
    /*******************************************
     * Start everything back with new settings *
     ******************************************/
    startHardware();
 
#if EFI_PROD_CODE && (BOARD_EXT_GPIOCHIPS > 0)
    /* TODO: properly restart gpio chips...
     * This is only workaround for "CS pin lost" bug
     * see: https://github.com/rusefi/rusefi/issues/2107
     * We should provide better way to gracefully stop all
     * gpio chips: set outputs to safe state, release all
     * on-chip resources (gpios, SPIs, etc) and then restart
     * with updated settings.
     * Following code just re-inits CS pins for all external
     * gpio chips, but does not update CS pin definition in
     * gpio chips private data/settings. So changing CS pin
     * on-fly does not work */
    startSmartCsPins();
#endif /* (BOARD_EXT_GPIOCHIPS > 0) */
 
    startKLine();
 
#if EFI_PROD_CODE && EFI_IDLE_CONTROL
    if (isIdleHardwareRestartNeeded()) {
         initIdleHardware();
    }
#endif
 
#if EFI_BOOST_CONTROL
    startBoostPin();
#endif
#if EFI_EMULATE_POSITION_SENSORS
    startTriggerEmulatorPins();
#endif /* EFI_EMULATE_POSITION_SENSORS */
#if EFI_LOGIC_ANALYZER
    startLogicAnalyzerPins();
#endif /* EFI_LOGIC_ANALYZER */
#if EFI_VVT_PID
    startVvtControlPins();
#endif /* EFI_VVT_PID */
 
#if EFI_PROD_CODE && EFI_SENT_SUPPORT
    startSent();
#endif
 
    calcFastAdcIndexes();
}

Referenced by incrementGlobalConfigurationVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

getMisoPin()

brain_pin_e getMisoPin

(

spi_device_e

device

)

Definition at line 89 of file hardware.cpp.

                                            {
    switch(device) {
    case SPI_DEVICE_1:
        return engineConfiguration->spi1misoPin;
    case SPI_DEVICE_2:
        return engineConfiguration->spi2misoPin;
    case SPI_DEVICE_3:
        return engineConfiguration->spi3misoPin;
    case SPI_DEVICE_4:
        return engineConfiguration->spi4misoPin;
    case SPI_DEVICE_5:
        return engineConfiguration->spi5misoPin;
    case SPI_DEVICE_6:
        return engineConfiguration->spi6misoPin;
    default:
        break;
    }
    return Gpio::Unassigned;
}

Referenced by printSpiConfig(), stopSpi(), and turnOnSpi().

Here is the caller graph for this function:

getMosiPin()

brain_pin_e getMosiPin

(

spi_device_e

device

)

Definition at line 109 of file hardware.cpp.

                                            {
    switch(device) {
    case SPI_DEVICE_1:
        return engineConfiguration->spi1mosiPin;
    case SPI_DEVICE_2:
        return engineConfiguration->spi2mosiPin;
    case SPI_DEVICE_3:
        return engineConfiguration->spi3mosiPin;
    case SPI_DEVICE_4:
        return engineConfiguration->spi4mosiPin;
    case SPI_DEVICE_5:
        return engineConfiguration->spi5mosiPin;
    case SPI_DEVICE_6:
        return engineConfiguration->spi6mosiPin;
    default:
        break;
    }
    return Gpio::Unassigned;
}

Referenced by printSpiConfig(), stopSpi(), and turnOnSpi().

Here is the caller graph for this function:

getSckPin()

brain_pin_e getSckPin

(

spi_device_e

device

)

Definition at line 129 of file hardware.cpp.

                                           {
    switch(device) {
    case SPI_DEVICE_1:
        return engineConfiguration->spi1sckPin;
    case SPI_DEVICE_2:
        return engineConfiguration->spi2sckPin;
    case SPI_DEVICE_3:
        return engineConfiguration->spi3sckPin;
    case SPI_DEVICE_4:
        return engineConfiguration->spi4sckPin;
    case SPI_DEVICE_5:
        return engineConfiguration->spi5sckPin;
    case SPI_DEVICE_6:
        return engineConfiguration->spi6sckPin;
    default:
        break;
    }
    return Gpio::Unassigned;
}

Referenced by printSpiConfig(), stopSpi(), and turnOnSpi().

Here is the caller graph for this function:

getSpiDevice()

SPIDriver * getSpiDevice

(

spi_device_e

spiDevice

)

Returns

NULL if SPI device not specified

Definition at line 152 of file hardware.cpp.

                                                 {
    if (spiDevice == SPI_NONE) {
        return nullptr;
    }
#if STM32_SPI_USE_SPI1
    if (spiDevice == SPI_DEVICE_1) {
        return &SPID1;
    }
#endif
#if STM32_SPI_USE_SPI2
    if (spiDevice == SPI_DEVICE_2) {
        return &SPID2;
    }
#endif
#if STM32_SPI_USE_SPI3
    if (spiDevice == SPI_DEVICE_3) {
        return &SPID3;
    }
#endif
#if STM32_SPI_USE_SPI4
    if (spiDevice == SPI_DEVICE_4) {
        return &SPID4;
    }
#endif
#if STM32_SPI_USE_SPI5
    if (spiDevice == SPI_DEVICE_5) {
        return &SPID5;
    }
#endif
#if STM32_SPI_USE_SPI6
    if (spiDevice == SPI_DEVICE_6) {
        return &SPID6;
    }
#endif
    firmwareError(ObdCode::CUSTOM_ERR_UNEXPECTED_SPI, "Unexpected SPI device: %d", spiDevice);
    return nullptr;
}

Referenced by initAccelerometer(), initializeMmcBlockDevice(), initPotentiometers(), initSmartGpio(), lockSpi(), nm_bus_init(), and unlockSpi().

Here is the call graph for this function:

Here is the caller graph for this function:

initHardware()

void initHardware

(

)

Definition at line 540 of file hardware.cpp.

                    {
    if (hasFirmwareError()) {
        return;
    }
 
#if EFI_PROD_CODE && STM32_I2C_USE_I2C3
    if (engineConfiguration->useEeprom) {
        i2cStart(&EE_U2CD, &i2cfg);
    }
#endif // STM32_I2C_USE_I2C3
 
    call_board_override(custom_board_InitHardware);
#if EFI_PROD_CODE
    // this applies some board configurations
    call_board_override(custom_board_OnConfigurationChange, nullptr);
#endif // EFI_PROD_CODE
 
    call_board_override(custom_board_InitHardwareExtra);
 
#if HAL_USE_ADC
    initAdcInputs();
#endif /* HAL_USE_ADC */
 
#if EFI_SOFTWARE_KNOCK
    initSoftwareKnock();
#endif /* EFI_SOFTWARE_KNOCK */
 
#ifdef TRIGGER_SCOPE
    initTriggerScope();
#endif // TRIGGER_SCOPE
 
#if HAL_USE_SPI
    initSpiModules();
#endif /* HAL_USE_SPI */
 
#if (EFI_PROD_CODE && BOARD_EXT_GPIOCHIPS > 0) || EFI_SIMULATOR
    // initSmartGpio depends on 'initSpiModules'
    initSmartGpio();
#endif
 
    // output pins potentially depend on 'initSmartGpio'
    initMiscOutputPins();
 
#if EFI_MC33816
    initMc33816();
#endif /* EFI_MC33816 */
 
#if EFI_CAN_SUPPORT
#if EFI_SIMULATOR
    // Set CAN device name
    CAND1.deviceName = "can0";
#endif
 
    initCan();
#endif /* EFI_CAN_SUPPORT */
 
 
#if EFI_PROD_CODE && EFI_SHAFT_POSITION_INPUT
    onEcuStartTriggerImplementation();
#endif /* EFI_SHAFT_POSITION_INPUT */
    onEcuStartDoSomethingTriggerInputPins();
 
#if EFI_WS2812
    initWS2812();
#endif /* EFI_LED_WS2812 */
 
#if EFI_ONBOARD_MEMS
    initAccelerometer();
#endif
 
#if EFI_BOSCH_YAW
    initBoschYawRateSensor();
#endif /* EFI_BOSCH_YAW */
 
#if EFI_UART_GPS
    initGps();
#endif
 
#if EFI_CAN_SUPPORT
    initCanVssSupport();
#endif // EFI_CAN_SUPPORT
 
#if EFI_CDM_INTEGRATION
    cdmIonInit();
#endif // EFI_CDM_INTEGRATION
 
#if EFI_PROD_CODE && EFI_SENT_SUPPORT
    initSent();
#endif
 
    initKLine();
 
#if EFI_DAC
    initDac();
#endif
 
    calcFastAdcIndexes();
 
    startHardware();
 
    efiPrintf("initHardware() OK!");
}

Referenced by commonEarlyInit().

Here is the call graph for this function:

Here is the caller graph for this function:

initHardwareNoConfig()

void initHardwareNoConfig

(

)

histograms is a data structure for CPU monitor, it does not depend on configuration

We need the LED_ERROR pin even before we read configuration

Definition at line 430 of file hardware.cpp.

                            {
    efiAssertVoid(ObdCode::CUSTOM_IH_STACK, hasLotsOfRemainingStack(), "init h");
 
    efiPrintf("initHardware()");
 
#if EFI_PROD_CODE
    initPinRepository();
#endif
 
#if EFI_PROD_CODE
    call_board_override(custom_board_InitHardwareEarly);
#endif
 
#if EFI_HISTOGRAMS
    /**
     * histograms is a data structure for CPU monitor, it does not depend on configuration
     */
    initHistogramsModule();
#endif /* EFI_HISTOGRAMS */
 
#if EFI_GPIO_HARDWARE
    /**
     * We need the LED_ERROR pin even before we read configuration
     */
    initPrimaryPins();
#endif // EFI_GPIO_HARDWARE
 
#if EFI_PROD_CODE && EFI_SIGNAL_EXECUTOR_ONE_TIMER
    // it's important to initialize this pretty early in the game before any scheduling usages
    initSingleTimerExecutorHardware();
#endif // EFI_PROD_CODE && EFI_SIGNAL_EXECUTOR_ONE_TIMER
 
#if EFI_PROD_CODE && EFI_RTC
    initRtc();
#endif // EFI_PROD_CODE && EFI_RTC
 
#if EFI_CONFIGURATION_STORAGE
    initFlash();
#endif
 
#if EFI_FILE_LOGGING
    initEarlyMmcCard();
#endif // EFI_FILE_LOGGING
 
#if HAL_USE_PAL && EFI_PROD_CODE
    // this should be initialized before detectBoardType()
    efiExtiInit();
#endif // HAL_USE_PAL
}

Referenced by runRusEfi().

Here is the call graph for this function:

Here is the caller graph for this function:

lockSpi()

void lockSpi

(

spi_device_e

device

)

Only one consumer can use SPI bus at a given time

Definition at line 193 of file hardware.cpp.

                                  {
    efiAssertVoid(ObdCode::CUSTOM_STACK_SPI, hasLotsOfRemainingStack(), "lockSpi");
    spiAcquireBus(getSpiDevice(device));
}

Referenced by sendToPot().

Here is the call graph for this function:

Here is the caller graph for this function:

onFastAdcComplete()

void onFastAdcComplete

(

adcsample_t *

)

This method is not in the adc* lower-level file because it is more business logic then hardware.

this callback is executed 10 000 times a second, it needs to be as fast as possible

Definition at line 278 of file hardware.cpp.

                                     {
    ScopePerf perf(PE::AdcCallbackFast);
 
#if HAL_TRIGGER_USE_ADC
    // we need to call this ASAP, because trigger processing is time-critical
    triggerAdcCallback(getFastAdc(triggerSampleIndex));
#endif /* HAL_TRIGGER_USE_ADC */
 
    /**
     * this callback is executed 10 000 times a second, it needs to be as fast as possible
     */
    efiAssertVoid(ObdCode::CUSTOM_STACK_ADC, hasLotsOfRemainingStack(), "lowstck#9b");
 
    auto mapRaw = adcRawValueToScaledVoltage(getFastAdc(fastMapSampleIndex), engineConfiguration->map.sensor.hwChannel);
    engine->outputChannels.rawMapFast = mapRaw;
#if EFI_MAP_AVERAGING && defined (MODULE_MAP_AVERAGING)
    mapAveragingAdcCallback(mapRaw);
#endif /* EFI_MAP_AVERAGING */
}

Referenced by adc_callback(), and fastAdcDoneCB().

Here is the call graph for this function:

Here is the caller graph for this function:

printSpiConfig()

void printSpiConfig	(	const char *	msg,
		spi_device_e	device
	)

Definition at line 259 of file hardware.cpp.

                                                          {
    efiPrintf("%s %s mosi=%s", msg, getSpi_device_e(device), hwPortname(getMosiPin(device)));
    efiPrintf("%s %s miso=%s", msg, getSpi_device_e(device), hwPortname(getMisoPin(device)));
    efiPrintf("%s %s sck=%s",  msg, getSpi_device_e(device), hwPortname(getSckPin(device)));
}

Referenced by sdStatistics().

Here is the call graph for this function:

Here is the caller graph for this function:

setBor()

void setBor

(

int

borValue

)

Definition at line 412 of file hardware.cpp.

                          {
    efiPrintf("setting BOR to %d", borValue);
    BOR_Set((BOR_Level_t)borValue);
}

Here is the call graph for this function:

startHardware()

void startHardware

(

)

This method is invoked both on ECU start and configuration change At the moment we have too many system which handle ECU start and configuration change separately TODO: move move hardware code here

Definition at line 505 of file hardware.cpp.

                     {
#if EFI_SHAFT_POSITION_INPUT
    initStartStopButton();
#endif
 
#if EFI_PROD_CODE && EFI_SHAFT_POSITION_INPUT
    startTriggerInputPins();
#endif /* EFI_SHAFT_POSITION_INPUT */
 
#if EFI_ENGINE_CONTROL
    enginePins.startPins();
#endif /* EFI_ENGINE_CONTROL */
 
#if EFI_SHAFT_POSITION_INPUT
    validateTriggerInputs();
 
#endif // EFI_SHAFT_POSITION_INPUT
 
    startSwitchPins();
 
#if EFI_CAN_SUPPORT
    startCanPins();
#endif /* EFI_CAN_SUPPORT */
}

Referenced by applyNewHardwareSettings(), and initHardware().

Here is the call graph for this function:

Here is the caller graph for this function:

stopHardware()

void stopHardware

(

)

Definition at line 480 of file hardware.cpp.

                    {
    stopSwitchPins();
 
#if EFI_PROD_CODE && (BOARD_EXT_GPIOCHIPS > 0)
    stopSmartCsPins();
#endif /* (BOARD_EXT_GPIOCHIPS > 0) */
 
#if EFI_LOGIC_ANALYZER
    stopLogicAnalyzerPins();
#endif /* EFI_LOGIC_ANALYZER */
 
#if EFI_EMULATE_POSITION_SENSORS
    stopTriggerEmulatorPins();
#endif /* EFI_EMULATE_POSITION_SENSORS */
 
#if EFI_VVT_PID
    stopVvtControlPins();
#endif /* EFI_VVT_PID */
}

Referenced by applyNewHardwareSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

turnOnSpi()

void turnOnSpi

(

spi_device_e

device

)

Definition at line 151 of file at32_spi.cpp.

                                    {
    if (isSpiInitialized[device])
        return; // already initialized
    isSpiInitialized[device] = true;
    if (device == SPI_DEVICE_1) {
// todo: introduce a nice structure with all fields for same SPI
#if STM32_SPI_USE_SPI1
//      scheduleMsg(&logging, "Turning on SPI1 pins");
        initSpiModule(&SPID1, getSckPin(device),
                getMisoPin(device),
                getMosiPin(device),
                engineConfiguration->spi1SckMode,
                engineConfiguration->spi1MosiMode,
                engineConfiguration->spi1MisoMode);
#else
        criticalError("SPI1 not available in this binary");
#endif /* STM32_SPI_USE_SPI1 */
    }
    if (device == SPI_DEVICE_2) {
#if STM32_SPI_USE_SPI2
        //scheduleMsg(&logging, "Turning on SPI2 pins");
        initSpiModule(&SPID2, getSckPin(device),
                getMisoPin(device),
                getMosiPin(device),
                engineConfiguration->spi2SckMode,
                engineConfiguration->spi2MosiMode,
                engineConfiguration->spi2MisoMode);
#else
        criticalError("SPI2 not available in this binary");
#endif /* STM32_SPI_USE_SPI2 */
    }
    if (device == SPI_DEVICE_3) {
#if STM32_SPI_USE_SPI3
        //scheduleMsg(&logging, "Turning on SPI3 pins");
        initSpiModule(&SPID3, getSckPin(device),
                getMisoPin(device),
                getMosiPin(device),
                engineConfiguration->spi3SckMode,
                engineConfiguration->spi3MosiMode,
                engineConfiguration->spi3MisoMode);
#else
        criticalError("SPI3 not available in this binary");
#endif /* STM32_SPI_USE_SPI3 */
    }
    if (device == SPI_DEVICE_4) {
#if STM32_SPI_USE_SPI4
        //scheduleMsg(&logging, "Turning on SPI4 pins");
        /* there are no configuration fields for SPI4 in engineConfiguration, rely on board init code
         * it should set proper functions for SPI4 pins */
#else
        criticalError("SPI4 not available in this binary");
#endif /* STM32_SPI_USE_SPI4 */
    }
}

Referenced by initSpiModules().

Here is the call graph for this function:

Here is the caller graph for this function:

unlockSpi()

void unlockSpi

(

spi_device_e

device

)

Definition at line 198 of file hardware.cpp.

                                    {
    spiReleaseBus(getSpiDevice(device));
}

Referenced by sendToPot().

Here is the call graph for this function:

Here is the caller graph for this function:

Go to the source code of this file.