FreeRTOS-RISCV/FreeRTOSv10.2.1/FreeRTOS-Plus/Source/Reliance-Edge/os/freertos/services/ostimestamp.c

110 lines
3.5 KiB
C

/* ----> DO NOT REMOVE THE FOLLOWING NOTICE <----
Copyright (c) 2014-2015 Datalight, Inc.
All Rights Reserved Worldwide.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; use version 2 of the License.
This program is distributed in the hope that it will be useful,
but "AS-IS," WITHOUT ANY WARRANTY; without even the implied warranty
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
/* Businesses and individuals that for commercial or other reasons cannot
comply with the terms of the GPLv2 license may obtain a commercial license
before incorporating Reliance Edge into proprietary software for
distribution in any form. Visit http://www.datalight.com/reliance-edge for
more information.
*/
/** @file
@brief Implements timestamp functions.
The functionality implemented herein is not needed for the file system
driver, only to provide accurate results with performance tests.
*/
#include <FreeRTOS.h>
#include <task.h>
#include <redfs.h>
/* configTICK_RATE_HZ is almost always 100, 250, 500, or 1000. If
1000000U % configTICK_RATE_HZ != 0, then RedOsTimePassed() will be a
little inaccurate.
*/
#define MICROSECS_PER_TICK (1000000U / configTICK_RATE_HZ)
/** @brief Initialize the timestamp service.
The behavior of invoking this function when timestamps are already
initialized is undefined.
@return A negated ::REDSTATUS code indicating the operation result.
@retval 0 Operation was successful.
@retval -RED_ENOSYS The timestamp service has not been implemented.
*/
REDSTATUS RedOsTimestampInit(void)
{
return 0;
}
/** @brief Uninitialize the timestamp service.
The behavior of invoking this function when timestamps are not initialized
is undefined.
@return A negated ::REDSTATUS code indicating the operation result.
@retval 0 Operation was successful.
*/
REDSTATUS RedOsTimestampUninit(void)
{
return 0;
}
/** @brief Retrieve a timestamp.
The behavior of invoking this function when timestamps are not initialized
is undefined
@return A timestamp which can later be passed to RedOsTimePassed() to
determine the amount of time which passed between the two calls.
*/
REDTIMESTAMP RedOsTimestamp(void)
{
return xTaskGetTickCount();
}
/** @brief Determine how much time has passed since a timestamp was retrieved.
The behavior of invoking this function when timestamps are not initialized
is undefined.
@param tsSince A timestamp acquired earlier via RedOsTimestamp().
@return The number of microseconds which have passed since @p tsSince.
*/
uint64_t RedOsTimePassed(
REDTIMESTAMP tsSince)
{
/* This works even if the tick count has wrapped around, provided it has
only wrapped around once.
*/
uint32_t ulTicksPassed = (uint32_t)xTaskGetTickCount() - tsSince;
uint64_t ullMicrosecs = (uint64_t)ulTicksPassed * MICROSECS_PER_TICK;
return ullMicrosecs;
}