| Michael Bestas | 3a0209e | 2023-05-04 01:15:47 +0300 | [diff] [blame] | 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 <stdint.h> |
| 38 | #include <loc_pla.h> |
| 39 | /* |
| 40 | user_data: client context pointer, passthrough. Originally received |
| 41 | from calling client when loc_timer_start() is called. |
| 42 | result: 0 if timer successfully timed out; else timer failed. |
| 43 | */ |
| 44 | typedef void (*loc_timer_callback)(void *user_data, int32_t result); |
| 45 | |
| 46 | |
| 47 | /* |
| 48 | delay_msec: timeout value for the timer. |
| 49 | cb_func: callback function pointer, implemented by client. |
| 50 | Can not be NULL. |
| 51 | user_data: client context pointer, passthrough. Will be |
| 52 | returned when loc_timer_callback() is called. |
| 53 | wakeOnExpire: true if to wake up CPU (if sleeping) upon timer |
| 54 | expiration and notify the client. |
| 55 | false if to wait until next time CPU wakes up (if |
| 56 | sleeping) and then notify the client. |
| 57 | Returns the handle, which can be used to stop the timer |
| 58 | NULL, if timer start fails (e.g. if cb_func is NULL). |
| 59 | */ |
| 60 | void* loc_timer_start(uint64_t delay_msec, |
| 61 | loc_timer_callback cb_func, |
| 62 | void *user_data, |
| 63 | bool wake_on_expire=false); |
| 64 | |
| 65 | /* |
| 66 | handle becomes invalid upon the return of the callback |
| 67 | */ |
| 68 | void loc_timer_stop(void*& handle); |
| 69 | |
| 70 | #ifdef __cplusplus |
| 71 | } |
| 72 | #endif /* __cplusplus */ |
| 73 | |
| 74 | #endif //__LOC_DELAY_H__ |