1 /* Copyright (c) 2013,2015 The Linux Foundation. All rights reserved. 2 * 3 * Redistribution and use in source and binary forms, with or without 4 * modification, are permitted provided that the following conditions are 5 * met: 6 * * Redistributions of source code must retain the above copyright 7 * notice, this list of conditions and the following disclaimer. 8 * * Redistributions in binary form must reproduce the above 9 * copyright notice, this list of conditions and the following 10 * disclaimer in the documentation and/or other materials provided 11 * with the distribution. 12 * * Neither the name of The Linux Foundation, nor the names of its 13 * contributors may be used to endorse or promote products derived 14 * from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 23 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 25 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 26 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 */ 29 30 #ifndef __LOC_DELAY_H__ 31 #define __LOC_DELAY_H__ 32 33 #ifdef __cplusplus 34 extern "C" { 35 #endif /* __cplusplus */ 36 #include <stddef.h> 37 #include <platform_lib_includes.h> 38 /* 39 user_data: client context pointer, passthrough. Originally received 40 from calling client when loc_timer_start() is called. 41 result: 0 if timer successfully timed out; else timer failed. 42 */ 43 typedef void (*loc_timer_callback)(void *user_data, int32_t result); 44 45 46 /* 47 delay_msec: timeout value for the timer. 48 cb_func: callback function pointer, implemented by client. 49 Can not be NULL. 50 user_data: client context pointer, passthrough. Will be 51 returned when loc_timer_callback() is called. 52 wakeOnExpire: true if to wake up CPU (if sleeping) upon timer 53 expiration and notify the client. 54 false if to wait until next time CPU wakes up (if 55 sleeping) and then notify the client. 56 Returns the handle, which can be used to stop the timer 57 NULL, if timer start fails (e.g. if cb_func is NULL). 58 */ 59 void* loc_timer_start(uint64_t delay_msec, 60 loc_timer_callback cb_func, 61 void *user_data, 62 bool wake_on_expire=false); 63 64 /* 65 handle becomes invalid upon the return of the callback 66 */ 67 void loc_timer_stop(void*& handle); 68 69 #ifdef __cplusplus 70 } 71 #endif /* __cplusplus */ 72 73 #endif //__LOC_DELAY_H__ 74