summaryrefslogtreecommitdiffstats
path: root/hal/clock_hal/hal_api/clock_hal.h
diff options
context:
space:
mode:
authorTadao Tanikawa <tanikawa.tadao@jp.panasonic.com>2020-11-20 23:36:23 +0900
committerTadao Tanikawa <tanikawa.tadao@jp.panasonic.com>2020-11-22 09:02:55 +0900
commit17cf21bcf8a2e29d2cbcf0a313474d2a4ee44f5d (patch)
tree582a9768558d9eaf261ca5df6136e9de54c95816 /hal/clock_hal/hal_api/clock_hal.h
parent9e86046cdb356913ae026f616e5bf17f6f238aa5 (diff)
Re-organized sub-directory by category
Since all the sub-directories were placed in the first level, created sub-directories, "hal", "module", and "service" for classification and relocated each component. Signed-off-by: Tadao Tanikawa <tanikawa.tadao@jp.panasonic.com> Change-Id: Ifdf743ac0d1893bd8e445455cf0d2c199a011d5c
Diffstat (limited to 'hal/clock_hal/hal_api/clock_hal.h')
-rwxr-xr-xhal/clock_hal/hal_api/clock_hal.h67
1 files changed, 67 insertions, 0 deletions
diff --git a/hal/clock_hal/hal_api/clock_hal.h b/hal/clock_hal/hal_api/clock_hal.h
new file mode 100755
index 0000000..8006b32
--- /dev/null
+++ b/hal/clock_hal/hal_api/clock_hal.h
@@ -0,0 +1,67 @@
+/*
+ * @copyright Copyright (c) 2017-2020 TOYOTA MOTOR CORPORATION.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef HAL_API_CLOCK_HAL_H_
+#define HAL_API_CLOCK_HAL_H_
+/**
+ * @file clock_hal.h
+ */
+#include <time.h>
+
+#include <native_service/frameworkunified_types.h>
+/** @addtogroup clock
+ * @{
+ */
+/** @addtogroup clock_hal
+ * @ingroup clock
+ * @{
+ */
+/**
+ * \ingroup SetHardwareClock
+ * \~english @par Brief
+ * API to set the RTC.
+ * \~english @param [in] h_app
+ * HANDLE - Handle for Application
+ * \~english @param [in] l_tm
+ * const struct tm * - pointer to the time will be set
+ * \~english @retval eFrameworkunifiedStatusOK : Ok
+ * \~english @retval eFrameworkunifiedStatusFail : Failed
+ * \~english @retval eFrameworkunifiedStatusInvldHandle : parameter "h_app" is NULL
+ * \~english @retval eFrameworkunifiedStatusNullPointer : parameter "l_tm" is NULL
+ * \~english @par Prerequisite
+ * - /dev/rtc node is exist, rtc driver is availability.
+ * \~english @par Change of internal state
+ * - Change of internal state according to the API does not occur.
+ * \~english @par Conditions of processing failure
+ * - Set time to RTC failed. [eFrameworkunifiedStatusFail]
+ * - The parameter "l_tm" is NULL. [eFrameworkunifiedStatusNullPointer]
+ * - The parameter "h_app" is NULL. [eFrameworkunifiedStatusInvldHandle]
+ * \~english @par Detail
+ * - Set time to RTC.
+ * - The API can be used by 1 process.
+ * \~english @par Classification
+ * Public
+ * \~english @par Type
+ * Sync
+ * \~english @see
+ * None
+ */
+EFrameworkunifiedStatus SetHardwareClock(HANDLE h_app, const struct tm *l_tm);
+
+
+/**@}*/ // end of clock_hal
+/**@}*/ // end of clock
+
+#endif // HAL_API_CLOCK_HAL_H_