mmc_card.cpp File Reference

Detailed Description

Date

Dec 28, 2013

Author

Kot_dnz

Andrey Belomutskiy, (c) 2012-2020

default pinouts in case of SPI2 connected to MMC: PB13 - SCK, PB14 - MISO, PB15 - MOSI, PD4 - CS, 3.3v default pinouts in case of SPI3 connected to MMC: PB3 - SCK, PB4 - MISO, PB5 - MOSI, PD4 - CS, 3.3v

todo: extract some logic into a controller file

Definition in file mmc_card.cpp.

Enumerations
enum	SD_STATUS {   SD_STATUS_INIT = 0 , SD_STATUS_MOUNTED , SD_STATUS_MOUNT_FAILED , SD_STATUS_OPEN_FAILED ,   SD_STATUS_SEEK_FAILED , SD_STATUS_NOT_INSERTED , SD_STATUS_CONNECTING , SD_STATUS_MSD ,   SD_STATUS_MMC_FAILED }

Functions
void	errorHandlerWriteReportFile (FIL *fd)
int	errorHandlerCheckReportFiles ()
void	errorHandlerDeleteReports ()
static const char *	sdStatusName (SD_STATUS status)
static void	sdLoggerSetReady (bool value)
static bool	sdLoggerIsReady ()
void	printFatFsError (const char *str, FRESULT f_error)
static void	printMmcPinout ()
static void	sdStatistics ()
static void	sdSetMode (const char *mode)
static void	prepareLogFileName ()
static int	sdLoggerCreateFile (FIL *fd)
	Create a new file with the specified name.
static void	sdLoggerCloseFile (FIL *fd)
static void	removeFile (const char *pathx)
static chibios_rt::BinarySemaphore	usbConnectedSemaphore (true)
void	onUsbConnectedNotifyMmcI ()
static bool	isSdCardEnabled ()
static BaseBlockDevice *	initializeMmcBlockDevice ()
static void	deinitializeMmcBlockDevide ()
static bool	useMsdMode ()
static bool	initMmc ()
static void	deinitMmc ()
static bool	mountMmc ()
static void	unmountMmc ()
static int	mlgLogger ()
static int	sdTriggerLogger ()
static int	sdLogger (FIL *fd)
static void	sdLoggerStart ()
static void	sdLoggerStop ()
static bool	sdFormat ()
static int	sdModeSwitchToIdle (SD_MODE from)
static int	sdModeSwitcher ()
static int	sdModeExecuter ()
static int	sdReportStorageInit ()
PUBLIC_API_WEAK bool	boardSdCardEnable ()
PUBLIC_API_WEAK bool	boardSdCardDisable ()
static	THD_WORKING_AREA (mmcThreadStack, 3 *UTILITY_THREAD_STACK_SIZE)
static	THD_FUNCTION (MMCmonThread, arg)
void	updateSdCardLiveFlags ()
void	initEarlyMmcCard ()
void	initMmcCard ()
void	sdCardRequestMode (SD_MODE mode)
SD_MODE	sdCardGetCurrentMode ()
void	sdCardRemoveReportFiles ()

Variables
static bool	sdLoggerReady = false
static NO_CACHE SdLogBufferWriter	logBuffer
static const char *	sdStatusNames []
static SD_STATUS	sdStatus = SD_STATUS_INIT
static SD_MODE	sdMode = SD_MODE_IDLE
static SD_MODE	sdTargetMode = SD_MODE_ECU
static bool	sdNeedRemoveReports = false
static spi_device_e	mmcSpiDevice = SPI_NONE
static NO_CACHE uint8_t	mmcbuf [MMC_BUFFER_SIZE]
MMCDriver	MMCD1
static MMCConfig	mmccfg
static NO_CACHE FATFS	MMC_FS
static const char *	fatErrors []
union {
FIL   fd
BYTE   formatBuff [FATFS_CLUSTER_SIZE]
uint8_t   blkbuf [4 *MMCSD_BLOCK_SIZE]
}	NO_CACHE
int	logFileIndex
static char	logName [_MAX_FILLER+20]
static const SDCConfig	sdcConfig
static BaseBlockDevice *	cardBlockDevice = nullptr
static bool	sdLoggerInitDone = false
static bool	sdLoggerFailed = false
static bool	sdLoggedSuppressed = false

Enumeration Type Documentation

SD_STATUS

enum SD_STATUS

Enumerator
SD_STATUS_INIT
SD_STATUS_MOUNTED
SD_STATUS_MOUNT_FAILED
SD_STATUS_OPEN_FAILED
SD_STATUS_SEEK_FAILED
SD_STATUS_NOT_INSERTED
SD_STATUS_CONNECTING
SD_STATUS_MSD
SD_STATUS_MMC_FAILED

Definition at line 161 of file mmc_card.cpp.

             {
    SD_STATUS_INIT = 0,
    SD_STATUS_MOUNTED,
    SD_STATUS_MOUNT_FAILED,
    SD_STATUS_OPEN_FAILED,
    SD_STATUS_SEEK_FAILED,
    SD_STATUS_NOT_INSERTED,
    SD_STATUS_CONNECTING,
    SD_STATUS_MSD,
    SD_STATUS_MMC_FAILED
} SD_STATUS;

Function Documentation

boardSdCardDisable()

PUBLIC_API_WEAK bool boardSdCardDisable

(

)

Definition at line 904 of file mmc_card.cpp.

                                          {
    return true;
}

Referenced by THD_FUNCTION().

Here is the caller graph for this function:

boardSdCardEnable()

PUBLIC_API_WEAK bool boardSdCardEnable

(

)

Definition at line 899 of file mmc_card.cpp.

                                         {
    // assume powered and ready
    return true;
}

Referenced by THD_FUNCTION().

Here is the caller graph for this function:

deinitializeMmcBlockDevide()

static void deinitializeMmcBlockDevide ( )

static

Definition at line 490 of file mmc_card.cpp.

                                         {
    blkDisconnect(&MMCD1);                      // Brings the driver in a state safe for card removal.
    mmcStop(&MMCD1);                            // Disables the MMC peripheral.
    UNLOCK_SD_SPI();
}

Referenced by deinitMmc().

Here is the caller graph for this function:

deinitMmc()

static void deinitMmc ( )

static

Definition at line 569 of file mmc_card.cpp.

                        {
    if (cardBlockDevice) {
        deinitializeMmcBlockDevide();
    }
    cardBlockDevice = nullptr;
    engine->outputChannels.sd_present = false;
}

Referenced by THD_FUNCTION().

Here is the call graph for this function:

Here is the caller graph for this function:

errorHandlerCheckReportFiles()

int errorHandlerCheckReportFiles ( )

extern

Definition at line 343 of file error_handling.cpp.

                                   {
    hasReportFile =
        (errorHandlerIsReportExist(ErrorCookie::FirmwareError) > 0) ||
        (errorHandlerIsReportExist(ErrorCookie::HardFault) > 0) ||
        (errorHandlerIsReportExist(ErrorCookie::ChibiOsPanic) > 0);
 
    return hasReportFile;
}

Referenced by errorHandlerDeleteReports(), and sdReportStorageInit().

Here is the call graph for this function:

Here is the caller graph for this function:

errorHandlerDeleteReports()

void errorHandlerDeleteReports ( )

extern

Definition at line 378 of file error_handling.cpp.

                                 {
    errorHandlerDeleteTypedReport(ErrorCookie::FirmwareError);
    errorHandlerDeleteTypedReport(ErrorCookie::HardFault);
    errorHandlerDeleteTypedReport(ErrorCookie::ChibiOsPanic);
 
    // update
    errorHandlerCheckReportFiles();
}

Referenced by sdModeExecuter().

Here is the call graph for this function:

Here is the caller graph for this function:

errorHandlerWriteReportFile()

void errorHandlerWriteReportFile ( FIL *  fd )

extern

Definition at line 275 of file error_handling.cpp.

                                          {
#if EFI_BACKUP_SRAM
    backupErrorState *err = &lastBootError;
    ErrorCookie cookie = err->Cookie;
#else
    ErrorCookie cookie = ErrorCookie::None;
#endif
 
    if (cookie != ErrorCookie::None) {
        needErrorReportFile = true;
    }
 
    auto cause = getMCUResetCause();
    // TODO: should we also report Unknown?
    if ((cause != Reset_Cause_NRST_Pin) && (cause != Reset_Cause_BOR) &&
        (cause != Reset_Cause_POR) && (cause != Reset_Cause_Unknown)) {
        // not an expected cause
        needErrorReportFile = true;
    }
 
    if (needErrorReportFile) {
        char fileName[_MAX_FILLER + 20];
        memset(fd, 0, sizeof(FIL));                     // clear the memory
        //TODO: use date + time for file name?
#if EFI_BACKUP_SRAM
        sprintf(fileName, "%05ld_%s_%s.txt",
            bootCount, FAIL_REPORT_PREFIX, errorHandlerGetErrorName(cookie));
#else
        sprintf(fileName, "last_%s_%s.txt",
            FAIL_REPORT_PREFIX, errorHandlerGetErrorName(cookie));
#endif
 
        FRESULT ret = f_open(fd, fileName, FA_CREATE_ALWAYS | FA_WRITE);
        if (ret == FR_OK) {
            //this is file print
            #define PRINT(format, ...) f_printf(fd, format "\r\n", __VA_ARGS__)
            printResetReason();
            printWdResetCounter();
#if EFI_BACKUP_SRAM
            printErrorState();
            printErrorStack();
#endif // EFI_BACKUP_SRAM
      f_printf(fd, "rusEFI v%d@%u", getRusEfiVersion(), /*do we have a working way to print 64 bit values?!*/(int)SIGNATURE_HASH);
            // additional board-specific data
            onBoardWriteErrorFile(fd);
            // todo: figure out what else would be useful
            f_close(fd);
            enginePins.warningLedPin.setValue(1);
        }
    }
}

Referenced by sdReportStorageInit().

Here is the call graph for this function:

Here is the caller graph for this function:

initEarlyMmcCard()

void initEarlyMmcCard

(

)

Definition at line 1033 of file mmc_card.cpp.

                        {
#if EFI_PROD_CODE
    logName[0] = 0;
 
    addConsoleAction("sdinfo", sdStatistics);
    addConsoleAction("sdsuppresslogging",  [](){
      sdLoggedSuppressed = true;
    efiPrintf("Suppressed!");
  });
    addConsoleActionS("del", removeFile);
    // sdmode pc
    // sdmode ecu
    addConsoleActionS("sdmode", sdSetMode);
    addConsoleAction("delreports", sdCardRemoveReportFiles);
    //incLogFileName() use same shared FDLogFile, calling it while FDLogFile is used by log writer will cause damage
    //addConsoleAction("incfilename", incLogFileName);
#endif // EFI_PROD_CODE
}

Referenced by initHardwareNoConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

initializeMmcBlockDevice()

static BaseBlockDevice * initializeMmcBlockDevice ( )

static

Definition at line 455 of file mmc_card.cpp.

                                                   {
    // Configures and activates the MMC peripheral.
    mmcSpiDevice = engineConfiguration->sdCardSpiDevice;
 
    // todo: reuse initSpiCs method?
    mmc_hs_spicfg.ssport = mmc_ls_spicfg.ssport = getHwPort("mmc", engineConfiguration->sdCardCsPin);
    mmc_hs_spicfg.sspad = mmc_ls_spicfg.sspad = getHwPin("mmc", engineConfiguration->sdCardCsPin);
    mmccfg.spip = getSpiDevice(mmcSpiDevice);
 
    // Invalid SPI device, abort.
    if (!mmccfg.spip) {
        return nullptr;
    }
 
    // max SPI rate is 25 MHz after init
    spiCalcClockDiv(mmccfg.spip, &mmc_hs_spicfg, 25 * 1000 * 1000);
    // and 250 KHz during initialization
    spiCalcClockDiv(mmccfg.spip, &mmc_ls_spicfg, 250 * 1000);
 
    // We think we have everything for the card, let's try to mount it!
    mmcObjectInit(&MMCD1, mmcbuf);
    mmcStart(&MMCD1, &mmccfg);
 
    // Performs the initialization procedure on the inserted card.
    LOCK_SD_SPI();
    if (blkConnect(&MMCD1) != HAL_SUCCESS) {
        sdStatus = SD_STATUS_MMC_FAILED;
        UNLOCK_SD_SPI();
        return nullptr;
    }
    // We intentionally never unlock in case of success, we take exclusive access of that spi device for SD use
 
    return reinterpret_cast<BaseBlockDevice*>(&MMCD1);
}

Referenced by initMmc().

Here is the call graph for this function:

Here is the caller graph for this function:

initMmc()

bool initMmc ( )

static

Definition at line 553 of file mmc_card.cpp.

                      {
    // Don't try to mount SD card in case of fatal error - hardware may be in an unexpected state
    if (hasFirmwareError()) {
        return false;
    }
 
    cardBlockDevice = initializeMmcBlockDevice();
 
#if EFI_TUNER_STUDIO
    // If not null, card is present
    engine->outputChannels.sd_present = cardBlockDevice != nullptr;
#endif
 
    return (cardBlockDevice != nullptr);
}

Referenced by THD_FUNCTION().

Here is the call graph for this function:

Here is the caller graph for this function:

initMmcCard()

void initMmcCard

(

)

Definition at line 1052 of file mmc_card.cpp.

                   {
#if EFI_PROD_CODE
    if (!isSdCardEnabled()) {
        // do not even bother starting the thread if SD card is not enabled & configured on start-up
        return;
    }
    chThdCreateStatic(mmcThreadStack, sizeof(mmcThreadStack), PRIO_MMC, (tfunc_t)(void*) MMCmonThread, NULL);
#endif // EFI_PROD_CODE
}

Referenced by commonEarlyInit().

Here is the call graph for this function:

Here is the caller graph for this function:

isSdCardEnabled()

static bool isSdCardEnabled ( )

static

Definition at line 445 of file mmc_card.cpp.

                              {
    return ((engineConfiguration->isSdCardEnabled) &&
            (engineConfiguration->sdCardSpiDevice != SPI_NONE) &&
            (isBrainPinValid(engineConfiguration->sdCardCsPin)));
}

Referenced by initMmcCard().

Here is the call graph for this function:

Here is the caller graph for this function:

mlgLogger()

static int mlgLogger ( )

static

Definition at line 966 of file mmc_card.cpp.

                       {
    // TODO: move this check somewhere out of here!
    // if the SPI device got un-picked somehow, cancel SD card
    // Don't do this check at all if using SDMMC interface instead of SPI
#if EFI_PROD_CODE && !defined(EFI_SDC_DEVICE)
    if (engineConfiguration->sdCardSpiDevice == SPI_NONE) {
        return 0;
    }
#endif
 
    systime_t before = chVTGetSystemTime();
 
    size_t writen = MLG::writeSdLogLine(logBuffer);
 
    // Something went wrong (already handled), so cancel further writes
    if (logBuffer.failed) {
        return -1;
    }
 
    auto freq = engineConfiguration->sdCardLogFrequency;
    if (freq > 250) {
        freq = 250;
    } else if (freq < 1) {
        freq = 1;
    }
 
    systime_t period = CH_CFG_ST_FREQUENCY / freq;
    chThdSleepUntilWindowed(before, before + period);
 
    return writen;
}

Referenced by sdLogger().

Here is the call graph for this function:

Here is the caller graph for this function:

mountMmc()

bool mountMmc ( )

static

Definition at line 579 of file mmc_card.cpp.

                       {
    FRESULT ret = FR_NOT_READY;
 
    // if no card, don't try to mount FS
    if (cardBlockDevice != nullptr) {
        // clean shared buffer
        memset(&resources, 0x00, sizeof(resources));
        // We were able to connect the SD card, mount the filesystem
        memset(&MMC_FS, 0, sizeof(FATFS));
        ret = f_mount(&MMC_FS, "", /* Mount immediately */ 1);
 
        if (ret != FR_OK) {
            sdStatus = SD_STATUS_MOUNT_FAILED;
            printFatFsError("Mount failed", ret);
        } else {
            sdStatus = SD_STATUS_MOUNTED;
            efiPrintf("SD card mounted!");
        }
    }
 
#if EFI_STORAGE_SD == TRUE
    if (ret == FR_OK) {
        // notificate storage subsystem
        initStorageSD();
    }
#endif // EFI_STORAGE_SD
 
#if EFI_TUNER_STUDIO
    engine->outputChannels.sd_error = (uint8_t) ret;
    engine->outputChannels.sd_logging_internal = (ret == FR_OK);
#endif
 
    return (ret == FR_OK);
}

Referenced by sdModeSwitcher(), and THD_FUNCTION().

Here is the call graph for this function:

Here is the caller graph for this function:

onUsbConnectedNotifyMmcI()

void onUsbConnectedNotifyMmcI

(

)

Definition at line 437 of file mmc_card.cpp.

                                {
    usbConnectedSemaphore.signalI();
}

Referenced by usb_event().

Here is the call graph for this function:

Here is the caller graph for this function:

prepareLogFileName()

static void prepareLogFileName ( )

static

Definition at line 344 of file mmc_card.cpp.

                                 {
    strcpy(logName, RUSEFI_LOG_PREFIX);
    char *ptr;
 
    // TS SD protocol supports only short 8 symbol file names, good thing that we do not use TS SD protocol!
    bool result = dateToStringShort(&logName[PREFIX_LEN]);
 
    if (result) {
        ptr = &logName[PREFIX_LEN + SHORT_TIME_LEN];
    } else {
        ptr = itoa10(&logName[PREFIX_LEN], logFileIndex);
    }
 
    if (engineConfiguration->sdTriggerLog) {
        strcat(ptr, ".teeth");
    } else {
        strcat(ptr, DOT_MLG);
    }
}

Referenced by sdLoggerCreateFile().

Here is the call graph for this function:

Here is the caller graph for this function:

printFatFsError()

void printFatFsError	(	const char *	str,
		FRESULT	f_error
	)

Definition at line 274 of file mmc_card.cpp.

                                                       {
    static int fatFsErrors = 0;
 
    if (fatFsErrors++ > 16) {
        // no reason to spam the console
        return;
    }
 
    efiPrintf("%s FATfs Error %d %s", str, f_error, f_error <= FR_INVALID_PARAMETER ? fatErrors[f_error] : "unknown");
}

Referenced by incLogFileName(), mountMmc(), sdFormat(), sdLoggerCreateFile(), and unmountMmc().

Here is the caller graph for this function:

printMmcPinout()

static void printMmcPinout ( )

static

Definition at line 299 of file mmc_card.cpp.

                             {
#if HAL_USE_MMC_SPI
    efiPrintf("MMC CS %s", hwPortname(engineConfiguration->sdCardCsPin));
    // todo: we need to figure out the right SPI pinout, not just SPI2
//  efiPrintf("MMC SCK %s:%d", portname(EFI_SPI2_SCK_PORT), EFI_SPI2_SCK_PIN);
//  efiPrintf("MMC MISO %s:%d", portname(EFI_SPI2_MISO_PORT), EFI_SPI2_MISO_PIN);
//  efiPrintf("MMC MOSI %s:%d", portname(EFI_SPI2_MOSI_PORT), EFI_SPI2_MOSI_PIN);
#else
  // not sure if we need to print SDIO pinout
#endif
}

Referenced by sdStatistics().

Here is the call graph for this function:

Here is the caller graph for this function:

removeFile()

static void removeFile ( const char *  pathx )

static

Definition at line 424 of file mmc_card.cpp.

                                          {
    if (sdMode != SD_MODE_ECU) {
        efiPrintf("SD card should be mounted to ECU");
        return;
    }
 
    f_unlink(pathx);
}

Referenced by initEarlyMmcCard().

Here is the caller graph for this function:

sdCardGetCurrentMode()

SD_MODE sdCardGetCurrentMode

(

)

Definition at line 1073 of file mmc_card.cpp.

{
    return sdMode;
}

Referenced by hellenDisableEn().

Here is the caller graph for this function:

sdCardRemoveReportFiles()

void sdCardRemoveReportFiles

(

)

Definition at line 1078 of file mmc_card.cpp.

                               {
    if (sdMode != SD_MODE_ECU) {
        efiPrintf("SD card should be mounted to ECU");
        return;
    }
 
    sdNeedRemoveReports = true;
}

Referenced by handleCommandX14(), and initEarlyMmcCard().

Here is the caller graph for this function:

sdCardRequestMode()

void sdCardRequestMode

(

SD_MODE

mode

)

Definition at line 1064 of file mmc_card.cpp.

{
    // Check if SD is not in transition state...
    if (sdTargetMode == SD_MODE_IDLE) {
        efiPrintf("sdCardRequestMode %d", (int)mode);
        sdTargetMode = mode;
    }
}

Referenced by handleCommandX14(), hellenDisableEn(), and sdSetMode().

Here is the caller graph for this function:

sdFormat()

static bool sdFormat ( )

static

Definition at line 750 of file mmc_card.cpp.

{
#if EFI_TUNER_STUDIO
    engine->outputChannels.sd_formating = true;
    engine->outputChannels.sd_error = 0;
#endif
    //FRESULT ret = f_mkfs("", nullptr, resources.formatBuff, sizeof(resources.formatBuff));
    FRESULT ret = f_mkfs("", nullptr, resources.formatBuff, sizeof(resources.formatBuff));
 
    if (ret) {
        printFatFsError("format failed", ret);
        warning(ObdCode::CUSTOM_ERR_SD_MOUNT_FAILED, "SD: format failed");
        goto exit;
    }
    ret = f_setlabel(SD_CARD_LABEL);
    if (ret) {
        printFatFsError("setlabel failed", ret);
        // this is not critical
        ret = FR_OK;
    }
 
exit:
#if EFI_TUNER_STUDIO
    engine->outputChannels.sd_formating = false;
    engine->outputChannels.sd_error = (uint8_t) ret;
#endif
 
    return (ret ? false : true);
}

Referenced by sdModeSwitcher().

Here is the call graph for this function:

Here is the caller graph for this function:

sdLogger()

static int sdLogger ( FIL *  fd )

static

Definition at line 668 of file mmc_card.cpp.

                             {
  if (sdLoggedSuppressed) {
    return 0;
  }
    int ret = 0;
 
    if (!sdLoggerInitDone) {
        incLogFileName(fd);
        MLG::resetFileLogging();
 
        ret = sdLoggerCreateFile(fd);
        if (ret == 0) {
            ret = logBuffer.start(fd);
        }
 
        sdLoggerInitDone = true;
 
        if (ret < 0) {
            sdLoggerFailed = true;
            return ret;
        }
    }
 
    if (!sdLoggerFailed) {
        if (engineConfiguration->sdTriggerLog) {
            ret = sdTriggerLogger();
        } else {
            ret = mlgLogger();
        }
    }
 
    if (ret < 0) {
        sdLoggerFailed = true;
        return ret;
    }
 
    if (sdLoggerFailed) {
        // logger is dead until restart, do not waste CPU
        chThdSleepMilliseconds(100);
        return -1;
    }
 
#ifdef LOGGER_MAX_FILE_SIZE
    // check if we need to start next log file
    // in next write (assume same size as current) will cross LOGGER_MAX_FILE_SIZE boundary
    // TODO: use f_tell() instead ?
    if (logBuffer.writen() + ret > LOGGER_MAX_FILE_SIZE) {
        logBuffer.stop();
        sdLoggerCloseFile(fd);
 
        //need to start new file
        sdLoggerInitDone = false;
    }
#endif
 
    return ret;
}

Referenced by sdModeExecuter().

Here is the call graph for this function:

Here is the caller graph for this function:

sdLoggerCloseFile()

static void sdLoggerCloseFile ( FIL *  fd )

static

Definition at line 410 of file mmc_card.cpp.

{
#ifdef LOGGER_MAX_FILE_SIZE
    // truncate file to actual size
    f_truncate(fd);
#endif
 
    // close file
    f_close(fd);
 
    // SD logger is inactive
    sdLoggerSetReady(false);
}

Referenced by sdLogger(), and sdLoggerStop().

Here is the call graph for this function:

Here is the caller graph for this function:

sdLoggerCreateFile()

static int sdLoggerCreateFile ( FIL *  fd )

static

Create a new file with the specified name.

This function saves the name of the file in a global variable so that we can later append to that file

Definition at line 370 of file mmc_card.cpp.

                                       {
    // turn off indicator
    sdLoggerSetReady(false);
 
    // clear the memory
    memset(fd, 0, sizeof(FIL));
    prepareLogFileName();
 
    efiPrintf("starting log file %s", logName);
    // Create new file. If file is exist - truncate and overwrite, we need header to be at zero offset.
    FRESULT err = f_open(fd, logName, FA_CREATE_ALWAYS | FA_WRITE);
    if (err == FR_EXIST) {
        err = FR_OK;
    }
#if EFI_TUNER_STUDIO
    // Show error to TS
    engine->outputChannels.sd_error = (uint8_t)err;
#endif
    if (err != FR_OK) {
        sdStatus = SD_STATUS_OPEN_FAILED;
        warning(ObdCode::CUSTOM_ERR_SD_MOUNT_FAILED, "SD: file open failed");
        printFatFsError("log file create", err);
        return -1;
    }
 
#ifdef LOGGER_MAX_FILE_SIZE
    //pre-allocate data ahead
    err = f_expand(fd, LOGGER_MAX_FILE_SIZE, /* Find and allocate */ 1);
    if (err != FR_OK) {
        printFatFsError("pre-allocate", err);
        // this is not critical
    }
#endif
 
    // SD logger is ok
    sdLoggerSetReady(true);
 
    return 0;
}

Referenced by sdLogger().

Here is the call graph for this function:

Here is the caller graph for this function:

sdLoggerIsReady()

static bool sdLoggerIsReady ( )

static

Definition at line 245 of file mmc_card.cpp.

                              {
    return sdLoggerReady;
}

Referenced by sdStatistics().

Here is the caller graph for this function:

sdLoggerSetReady()

static void sdLoggerSetReady ( bool  value )

static

Definition at line 241 of file mmc_card.cpp.

                                         {
    sdLoggerReady = value;
}

Referenced by sdLoggerCloseFile(), and sdLoggerCreateFile().

Here is the caller graph for this function:

sdLoggerStart()

static void sdLoggerStart ( )

static

Definition at line 726 of file mmc_card.cpp.

{
    sdLoggerInitDone = false;
    sdLoggerFailed = false;
 
#if EFI_TOOTH_LOGGER
    // TODO: cache this config option untill sdLoggerStop()
    if (engineConfiguration->sdTriggerLog) {
        EnableToothLogger();
    }
#endif
}

Referenced by sdModeSwitcher().

Here is the call graph for this function:

Here is the caller graph for this function:

sdLoggerStop()

static void sdLoggerStop ( )

static

Definition at line 739 of file mmc_card.cpp.

{
    sdLoggerCloseFile(&resources.fd);
#if EFI_TOOTH_LOGGER
    // TODO: cache this config option untill sdLoggerStop()
    if (engineConfiguration->sdTriggerLog) {
        DisableToothLogger();
    }
#endif
}

Referenced by sdModeSwitchToIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

sdModeExecuter()

static int sdModeExecuter ( )

static

Definition at line 866 of file mmc_card.cpp.

{
    switch (sdMode) {
    case SD_MODE_IDLE:
    case SD_MODE_PC:
    case SD_MODE_UNMOUNT:
    case SD_MODE_FORMAT:
        // nothing to do in these state, just sleep
        chThdSleepMilliseconds(100);
        return 0;
    case SD_MODE_ECU:
        if (sdNeedRemoveReports) {
            errorHandlerDeleteReports();
            sdNeedRemoveReports = false;
        }
        // execute logger
        return sdLogger(&resources.fd);
    }
 
    return 0;
}

Referenced by THD_FUNCTION().

Here is the call graph for this function:

Here is the caller graph for this function:

sdModeSwitcher()

static int sdModeSwitcher ( )

static

Definition at line 803 of file mmc_card.cpp.

{
    if (sdTargetMode == SD_MODE_IDLE) {
        return 0;
    }
 
    if (sdMode == sdTargetMode) {
        // already here
        sdTargetMode = SD_MODE_IDLE;
        return 0;
    }
 
    if (sdMode != SD_MODE_IDLE) {
        int ret = sdModeSwitchToIdle(sdMode);
        if (ret) {
            return ret;
        }
        sdMode = SD_MODE_IDLE;
    }
 
    if (sdMode != SD_MODE_IDLE) {
        return -1;
    }
 
    // Now SD card is in idle state, we can switch into target state
    switch (sdTargetMode) {
    case SD_MODE_IDLE:
        return 0;
    case SD_MODE_UNMOUNT:
        // everything is done in sdModeSwitchToIdle();
        sdMode = SD_MODE_UNMOUNT;
        sdTargetMode = SD_MODE_IDLE;
        return 0;
    case SD_MODE_ECU:
        if (mountMmc()) {
            sdLoggerStart();
            sdMode = SD_MODE_ECU;
        } else {
            // failed to mount SD card to ECU, go to idle
            sdMode = SD_MODE_IDLE;
        }
        sdTargetMode = SD_MODE_IDLE;
        return 0;
    case SD_MODE_PC:
        attachMsdSdCard(cardBlockDevice, resources.blkbuf, sizeof(resources.blkbuf));
        sdStatus = SD_STATUS_MSD;
        sdMode = SD_MODE_PC;
        sdTargetMode = SD_MODE_IDLE;
        return 0;
    case SD_MODE_FORMAT:
        if (sdFormat()) {
            // formated ok
        }
        sdMode = SD_MODE_IDLE;
        // TODO: return to mode that was used before format was requested!
        sdTargetMode = SD_MODE_IDLE;
        return 0;
    }
 
    // should not happen
    return -1;
}

Referenced by THD_FUNCTION().

Here is the call graph for this function:

Here is the caller graph for this function:

sdModeSwitchToIdle()

static int sdModeSwitchToIdle ( SD_MODE  from )

static

Definition at line 780 of file mmc_card.cpp.

{
    switch (from) {
    case SD_MODE_IDLE:
        return 0;
    case SD_MODE_ECU:
        sdLoggerStop();
        unmountMmc();
        return 0;
    case SD_MODE_PC:
        deattachMsdSdCard();
        return 0;
    case SD_MODE_UNMOUNT:
        return 0;
    case SD_MODE_FORMAT:
        //not allowed to interrupt formating process
        return -1;
    }
 
    efiPrintf("Invalid SD card thread state: %d", static_cast<int>(from));
    return -1;
}

Referenced by sdModeSwitcher().

Here is the call graph for this function:

Here is the caller graph for this function:

sdReportStorageInit()

static int sdReportStorageInit ( )

static

Definition at line 888 of file mmc_card.cpp.

{
    // write error report file if needed
    errorHandlerWriteReportFile(&resources.fd);
 
    // check for any exist reports
    errorHandlerCheckReportFiles();
 
    return 0;
}

Referenced by THD_FUNCTION().

Here is the call graph for this function:

Here is the caller graph for this function:

sdSetMode()

static void sdSetMode ( const char *  mode )

static

Definition at line 334 of file mmc_card.cpp.

                                        {
    if (strcmp(mode, "pc") == 0) {
        sdCardRequestMode(SD_MODE_PC);
    } else if (strcmp(mode, "ecu") == 0) {
        sdCardRequestMode(SD_MODE_ECU);
    } else {
        efiPrintf("Invalid mode %s allowed modes pc and ecu", mode);
    }
}

Referenced by initEarlyMmcCard().

Here is the call graph for this function:

Here is the caller graph for this function:

sdStatistics()

static void sdStatistics ( )

static

Definition at line 311 of file mmc_card.cpp.

                           {
    printMmcPinout();
    efiPrintf("SD enabled=%s status=%s", boolToString(engineConfiguration->isSdCardEnabled),
            sdStatusName(sdStatus));
#if HAL_USE_MMC_SPI
    printSpiConfig("SD", mmcSpiDevice);
 #if defined(STM32F4XX) || defined(STM32F7XX)
    efiPrintf("HS clock %d Hz", spiGetBaseClock(mmccfg.spip) / (2 << ((mmc_hs_spicfg.cr1 & SPI_CR1_BR_Msk) >> SPI_CR1_BR_Pos)));
    efiPrintf("LS clock %d Hz", spiGetBaseClock(mmccfg.spip) / (2 << ((mmc_ls_spicfg.cr1 & SPI_CR1_BR_Msk) >> SPI_CR1_BR_Pos)));
 #else
  efiPrintf("not implemented");
 #endif
#else
 efiPrintf("SDIO mode");
#endif
    if (sdLoggerIsReady()) {
        efiPrintf("filename=%s size=%d", logName, logBuffer.writen());
    }
#if EFI_FILE_LOGGING
    efiPrintf("%d SD card fields", MLG::getSdCardFieldsCount());
#endif
}

Referenced by initEarlyMmcCard().

Here is the call graph for this function:

Here is the caller graph for this function:

sdStatusName()

static const char * sdStatusName ( SD_STATUS  status )

static

Definition at line 187 of file mmc_card.cpp.

{
    return sdStatusNames[status];
}

Referenced by sdStatistics().

Here is the caller graph for this function:

sdTriggerLogger()

static int sdTriggerLogger ( )

static

Definition at line 998 of file mmc_card.cpp.

                             {
    size_t toWrite = 0;
#if EFI_TOOTH_LOGGER
    auto buffer = GetToothLoggerBufferBlocking();
 
    // can return nullptr
    if (buffer) {
        toWrite = buffer->nextIdx * sizeof(composite_logger_s);
        logBuffer.write(reinterpret_cast<const char*>(buffer->buffer), toWrite);
        if (logBuffer.failed) {
            return -1;
        }
 
        ReturnToothLoggerBuffer(buffer);
    }
#endif /* EFI_TOOTH_LOGGER */
    return toWrite;
}

Referenced by sdLogger().

Here is the call graph for this function:

Here is the caller graph for this function:

THD_FUNCTION()

static THD_FUNCTION ( MMCmonThread  , arg    )

static

Definition at line 909 of file mmc_card.cpp.

                                       {
    (void)arg;
 
    chRegSetThreadName("SD Card Logger");
 
    while (!boardSdCardEnable()) {
        // wait until board enables peripheral
        chThdSleepMilliseconds(100);
    }
 
    sdStatus = SD_STATUS_CONNECTING;
    if (!initMmc()) {
        efiPrintf("Card is not preset/failed to init");
        sdStatus = SD_STATUS_NOT_INSERTED;
        // give up until next boot
        goto die;
    }
 
    // Try to mount SD card, drop critical report if needed and check for previously stored reports
    if (mountMmc()) {
        sdReportStorageInit();
 
        sdMode = SD_MODE_ECU;
 
#if EFI_STORAGE_SD == TRUE
        // Give some time for storage manager to load settings from SD
        chThdSleepMilliseconds(1000);
#endif
    }
 
#if HAL_USE_USB_MSD
    // Wait for the USB stack to wake up, or a 15 second timeout, whichever occurs first
    // If we have a device AND USB is connected, mount the card to USB, otherwise
    // mount the null device and try to mount the filesystem ourselves
    if (useMsdMode()) {
        sdTargetMode = SD_MODE_PC;
    }
#endif
 
    while (1) {
        sdModeSwitcher();
        sdModeExecuter();
    }
 
die:
    // bring SD interface to safe state
    deinitMmc();
    boardSdCardDisable();
 
    efiPrintf("SD logger has died!");
 
    // exiting thread will create zombie!
    while(1) {
        chThdSleepMilliseconds(100);
    }
}

Here is the call graph for this function:

THD_WORKING_AREA()

static THD_WORKING_AREA ( mmcThreadStack  , 3 *  UTILITY_THREAD_STACK_SIZE  )

static

unmountMmc()

static void unmountMmc ( )

static

Definition at line 618 of file mmc_card.cpp.

                         {
    FRESULT ret;
 
#if EFI_STORAGE_SD == TRUE
    // notificate storage subsystem
    deinitStorageSD();
#endif // EFI_STORAGE_SD
 
    // FATFS: Unregister work area prior to discard it
    ret = f_unmount("");
    if (ret != FR_OK) {
        printFatFsError("Umount failed", ret);
    }
 
#if EFI_TUNER_STUDIO
    engine->outputChannels.sd_error = (uint8_t) ret;
    engine->outputChannels.sd_logging_internal = false;
#endif
 
    efiPrintf("SD card unmounted");
}

Referenced by sdModeSwitchToIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

updateSdCardLiveFlags()

void updateSdCardLiveFlags

(

)

Definition at line 1019 of file mmc_card.cpp.

                             {
#if EFI_PROD_CODE
    if (cardBlockDevice) {
        engine->outputChannels.sd_active_wr = (blkGetDriverState(cardBlockDevice) == BLK_WRITING);
        engine->outputChannels.sd_active_rd = (blkGetDriverState(cardBlockDevice) == BLK_READING);
    } else
#endif // EFI_PROD_CODE
    {
        engine->outputChannels.sd_active_wr = false;
        engine->outputChannels.sd_active_rd = false;
    }
}

Referenced by updateFlags().

Here is the caller graph for this function:

usbConnectedSemaphore()

static chibios_rt::BinarySemaphore usbConnectedSemaphore ( true  )

static

Referenced by onUsbConnectedNotifyMmcI(), and useMsdMode().

Here is the caller graph for this function:

useMsdMode()

static bool useMsdMode ( )

static

Definition at line 534 of file mmc_card.cpp.

                         {
    if (engineConfiguration->alwaysWriteSdCard) {
        return false;
    }
    if (isIgnVoltage()) {
      // if we have battery voltage let's give priority to logging not reading
      // this gives us a chance to SD card log cranking
      return false;
    }
    // Wait for the USB stack to wake up, or a 15 second timeout, whichever occurs first
    msg_t usbResult = usbConnectedSemaphore.wait(TIME_MS2I(15000));
 
    return usbResult == MSG_OK;
}

Referenced by THD_FUNCTION().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

blkbuf

uint8_t blkbuf[4 *MMCSD_BLOCK_SIZE]

Definition at line 293 of file mmc_card.cpp.

Referenced by MassStorageController::attachLun(), and attachMsdSdCard().

cardBlockDevice

BaseBlockDevice* cardBlockDevice = nullptr

static

Definition at line 550 of file mmc_card.cpp.

Referenced by deinitMmc(), initMmc(), mountMmc(), sdModeSwitcher(), and updateSdCardLiveFlags().

fatErrors

const char* fatErrors[]

static

Initial value:

= {
    "FR_OK: Succeeded",
    "FR_DISK_ERR: A hard error occurred in the low level disk I/O layer",
    "FR_INT_ERR: Assertion failed",
    "FR_NOT_READY: The physical drive cannot work",
    "FR_NO_FILE: Could not find the file",
    "FR_NO_PATH: Could not find the path",
    "FR_INVALID_NAME: The path name format is invalid",
    "FR_DENIED: Access denied due to prohibited access or directory full",
    "FR_EXIST: Access denied due to prohibited access",
    "FR_INVALID_OBJECT: The file/directory object is invalid",
    "FR_WRITE_PROTECTED: The physical drive is write protected",
    "FR_INVALID_DRIVE: The logical drive number is invalid",
    "FR_NOT_ENABLED: The volume has no work area",
    "FR_NO_FILESYSTEM: There is no valid FAT volume",
    "FR_MKFS_ABORTED: The f_mkfs() aborted due to any problem",
    "FR_TIMEOUT: Could not get a grant to access the volume within defined period",
    "FR_LOCKED: The operation is rejected according to the file sharing policy",
    "FR_NOT_ENOUGH_CORE: LFN working buffer could not be allocated",
    "FR_TOO_MANY_OPEN_FILES: Number of open files > FF_FS_LOCK",
    "FR_INVALID_PARAMETER: Given parameter is invalid"
}

Definition at line 250 of file mmc_card.cpp.

                                 {
    "FR_OK: Succeeded",
    "FR_DISK_ERR: A hard error occurred in the low level disk I/O layer",
    "FR_INT_ERR: Assertion failed",
    "FR_NOT_READY: The physical drive cannot work",
    "FR_NO_FILE: Could not find the file",
    "FR_NO_PATH: Could not find the path",
    "FR_INVALID_NAME: The path name format is invalid",
    "FR_DENIED: Access denied due to prohibited access or directory full",
    "FR_EXIST: Access denied due to prohibited access",
    "FR_INVALID_OBJECT: The file/directory object is invalid",
    "FR_WRITE_PROTECTED: The physical drive is write protected",
    "FR_INVALID_DRIVE: The logical drive number is invalid",
    "FR_NOT_ENABLED: The volume has no work area",
    "FR_NO_FILESYSTEM: There is no valid FAT volume",
    "FR_MKFS_ABORTED: The f_mkfs() aborted due to any problem",
    "FR_TIMEOUT: Could not get a grant to access the volume within defined period",
    "FR_LOCKED: The operation is rejected according to the file sharing policy",
    "FR_NOT_ENOUGH_CORE: LFN working buffer could not be allocated",
    "FR_TOO_MANY_OPEN_FILES: Number of open files > FF_FS_LOCK",
    "FR_INVALID_PARAMETER: Given parameter is invalid"
};

Referenced by printFatFsError().

fd

FIL fd

Definition at line 288 of file mmc_card.cpp.

Referenced by sdLogger(), sdLoggerCloseFile(), and sdLoggerCreateFile().

formatBuff

BYTE formatBuff[FATFS_CLUSTER_SIZE]

Definition at line 291 of file mmc_card.cpp.

logBuffer

NO_CACHE SdLogBufferWriter logBuffer

static

Definition at line 149 of file mmc_card.cpp.

Referenced by mlgLogger(), sdLogger(), sdStatistics(), and sdTriggerLogger().

logFileIndex

int logFileIndex

extern

Definition at line 16 of file mmc_card_util.cpp.

Referenced by incLogFileName(), and prepareLogFileName().

logName

char logName[_MAX_FILLER+20]

static

Definition at line 297 of file mmc_card.cpp.

Referenced by initEarlyMmcCard(), prepareLogFileName(), sdLoggerCreateFile(), and sdStatistics().

MMC_FS

NO_CACHE FATFS MMC_FS

static

fatfs MMC/SPI

Definition at line 239 of file mmc_card.cpp.

Referenced by mountMmc().

mmcbuf

NO_CACHE uint8_t mmcbuf[MMC_BUFFER_SIZE]

static

MMC driver instance.

Definition at line 216 of file mmc_card.cpp.

Referenced by initializeMmcBlockDevice().

mmccfg

MMCConfig mmccfg

static

Initial value:

= {
    .spip = NULL,
    .lscfg = &mmc_ls_spicfg,
    .hscfg = &mmc_hs_spicfg
}

Definition at line 220 of file mmc_card.cpp.

                          {
    .spip = NULL,
    .lscfg = &mmc_ls_spicfg,
    .hscfg = &mmc_hs_spicfg
};

Referenced by initializeMmcBlockDevice(), and sdStatistics().

MMCD1

MMCDriver MMCD1

Definition at line 217 of file mmc_card.cpp.

Referenced by deinitializeMmcBlockDevide(), and initializeMmcBlockDevice().

mmcSpiDevice

spi_device_e mmcSpiDevice = SPI_NONE

static

on't re-read SD card spi device after boot - it could change mid transaction (TS thread could preempt), which will cause disaster (usually multiple-unlock of the same mutex in UNLOCK_SD_SPI)

Definition at line 211 of file mmc_card.cpp.

Referenced by initializeMmcBlockDevice(), and sdStatistics().

[union]

union { ... } NO_CACHE

sdcConfig

const SDCConfig sdcConfig

static

Initial value:

= {
    .bus_width = RE_SDC_MODE,
    .slowdown = 0U
}

Definition at line 504 of file mmc_card.cpp.

                                   {
    .bus_width = RE_SDC_MODE,
    .slowdown = 0U
};

sdLoggedSuppressed

bool sdLoggedSuppressed = false

static

Definition at line 665 of file mmc_card.cpp.

Referenced by initEarlyMmcCard(), and sdLogger().

sdLoggerFailed

bool sdLoggerFailed = false

static

Definition at line 663 of file mmc_card.cpp.

Referenced by sdLogger(), and sdLoggerStart().

sdLoggerInitDone

bool sdLoggerInitDone = false

static

Definition at line 662 of file mmc_card.cpp.

Referenced by sdLogger(), and sdLoggerStart().

sdLoggerReady

bool sdLoggerReady = false

static

Definition at line 32 of file mmc_card.cpp.

Referenced by sdLoggerIsReady(), and sdLoggerSetReady().

sdMode

SD_MODE sdMode = SD_MODE_IDLE

static

Definition at line 194 of file mmc_card.cpp.

Referenced by removeFile(), sdCardGetCurrentMode(), sdCardRemoveReportFiles(), sdModeExecuter(), sdModeSwitcher(), and THD_FUNCTION().

sdNeedRemoveReports

bool sdNeedRemoveReports = false

static

Definition at line 198 of file mmc_card.cpp.

Referenced by sdCardRemoveReportFiles(), and sdModeExecuter().

sdStatus

SD_STATUS sdStatus = SD_STATUS_INIT

static

Definition at line 192 of file mmc_card.cpp.

Referenced by initializeMmcBlockDevice(), mountMmc(), sdLoggerCreateFile(), sdModeSwitcher(), sdStatistics(), and THD_FUNCTION().

sdStatusNames

const char* sdStatusNames[]

static

Initial value:

=
{
    "INIT",
    "MOUNTED",
    "MOUNT_FAILED",
    "OPEN_FAILED",
    "SEEK_FAILED",
    "NOT_INSERTED",
    "CONNECTING",
    "MSD",
    "MMC_CONNECT_FAILED"
}

Definition at line 174 of file mmc_card.cpp.

{
    "INIT",
    "MOUNTED",
    "MOUNT_FAILED",
    "OPEN_FAILED",
    "SEEK_FAILED",
    "NOT_INSERTED",
    "CONNECTING",
    "MSD",
    "MMC_CONNECT_FAILED"
};

Referenced by sdStatusName().

sdTargetMode

SD_MODE sdTargetMode = SD_MODE_ECU

static

Definition at line 196 of file mmc_card.cpp.

Referenced by sdCardRequestMode(), sdModeSwitcher(), and THD_FUNCTION().

Go to the source code of this file.