IO_ProfilerStartCheckpoint

Syntax

#include <cafe/io_prof.h>

IO_PROF_RVAL IO_ProfilerStartCheckpoint(u32 flags);

Parameters

flags Currently unused, pass 0.

Return Values

IO_PROF_RVAL IO_PROF_RVAL_OK upon success, appropriate error code on failure.

Description

Start a profiler checkpoint.

NOTE:
Any previous IO profiling captured data is reset.

IO_ProfilerStartCheckpoint should be called at least once before calling IO_ProfilerGetStatsAndEndCheckpoint or IO_ProfilerGetStatsAndRestartCheckpoint.

Do Not Call From

Callbacks Do not call this function from any callback function.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.
Production code Do not call this function in production code. It is available only for debugging purposes.

See Also

IO_ProfilerGetStatsAndRestartCheckpoint
IO_ProfilerGetStatsAndEndCheckpoint

Revision History

2013/06/19 Initial version.


CONFIDENTIAL