R01US0079ED0103 Datasheet, PDF (40/66 Pages) Renesas Technology Corp – RENESAS 32-Bit MCU

Data Flash Access Library - Type T01, European Release
User Interface (API)
Return value
Type
r_fdl_status_t
Description
 R_FDL_OK
FDL operation finished successfully
 R_FDL_BUSY
The started Flash operation is still on-going
 R_FDL_ ERR_REJECTED
Flow error:
 Library is not initialized
 Library is already in stand-by mode
Pre- R_FDL_Init must have been executed successfully.
conditions:
FDL is not in stand-by mode.
Post- Repeat the execution of the R_FDL_StandBy function until the state indicated by the
conditions: _{function changes from R_FDL_BUSY.}
Do not execute functions R_FDL_Execute, R_FDL_SuspendRequest,
R_FDL_ResumeRequest or R_FDL_StandBy when FDL is in stand-by state.
Description: This function suspends an ongoing flash operation and brings FDL into stand-by state.
The system can then change to special states (e.g. change power mode).
Function does not necessarily immediately suspend any Flash operation, as suspend
might be delayed by the device internal hardware or might not be supported at all (only
Erase and Write are suspendable). So, the function R_FDL_StandBy tries to suspend
the Flash operation and returns R_FDL_BUSY as long as a Flash operation is on-going. If
suspend was not possible (e.g. blank check operation), R_FDL_BUSY is returned until the
operation is finished normally.
So, in order to be sure to have no Flash operation on-going, the function must be called
continuously until the function does no longer return R_FDL_BUSY or until a timeout
occurred.
After stand-by, it is mandatory to call R_FDL_WakeUp to resume normal FDL operation
again. The prescribed sequence in case of using R_FDL_StandBy/R_FDL_WakeUp is:
 any FDL command is in operation
 call R_FDL_StandBy until it does no longer return R_FDL_BUSY
 put device in power save (stand-by) mode
 device wake-up
 call R_FDL_WakeUp
 continue with initial FDL command
Note:
Please consider not entering a power save mode (e.g. Deep Stop mode) which
resets the Flash hardware, alter stack or library variables, because a resume of the
previous operation is not possible afterwards. The library is not able to detect this
failure.
Example:
r_fdl_status_t fdlRet_enu;
r_fdl_request_t myReq_str_str;
R01US0079ED0103
40
User Manual