lp_ticker_api_tests.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2017-2017 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 /** \addtogroup hal_lp_ticker_tests
00018  *  @{
00019  */
00020 
00021 #ifndef LP_TICKER_API_TESTS_H
00022 #define LP_TICKER_API_TESTS_H
00023 
00024 #include "device.h"
00025 
00026 
00027 #ifdef __cplusplus
00028 extern "C" {
00029 #endif
00030 
00031 /** Test that the ticker has the correct frequency and number of bits.
00032  *
00033  * Given ticker is available.
00034  * When ticker information data is obtained.
00035  * Then collected data indicates that ticker frequency is between 4KHz and 64KHz and the counter is at least 12 bits wide.
00036  */
00037 void lp_ticker_info_test(void);
00038 
00039 /** Test that the ticker continues operating in deep sleep mode.
00040  *
00041  * Given ticker is available.
00042  * When ticker has interrupt set and board enters deep-sleep mode.
00043  * Then ticker continues operating.
00044  */
00045 void lp_ticker_deepsleep_test(void);
00046 
00047 /** Test that the ticker does not glitch backwards due to an incorrectly implemented ripple counter driver.
00048  *
00049  * Given ticker is available.
00050  * When ticker is enabled and counts.
00051  * Then ticker does not glitch backwards due to an incorrectly implemented ripple counter driver.
00052  */
00053 void lp_ticker_glitch_test(void);
00054 /**@}*/
00055 
00056 #ifdef __cplusplus
00057 }
00058 #endif
00059 
00060 #endif
00061 
00062 /**@}*/