xref: /btstack/platform/embedded/hal_tick.h (revision a705b1a26dcfbf2c605ea712f75a1ebdcf0586f3)
1*a705b1a2SMatthias Ringwald /*
2*a705b1a2SMatthias Ringwald  * Copyright (C) 2014 BlueKitchen GmbH
3*a705b1a2SMatthias Ringwald  *
4*a705b1a2SMatthias Ringwald  * Redistribution and use in source and binary forms, with or without
5*a705b1a2SMatthias Ringwald  * modification, are permitted provided that the following conditions
6*a705b1a2SMatthias Ringwald  * are met:
7*a705b1a2SMatthias Ringwald  *
8*a705b1a2SMatthias Ringwald  * 1. Redistributions of source code must retain the above copyright
9*a705b1a2SMatthias Ringwald  *    notice, this list of conditions and the following disclaimer.
10*a705b1a2SMatthias Ringwald  * 2. Redistributions in binary form must reproduce the above copyright
11*a705b1a2SMatthias Ringwald  *    notice, this list of conditions and the following disclaimer in the
12*a705b1a2SMatthias Ringwald  *    documentation and/or other materials provided with the distribution.
13*a705b1a2SMatthias Ringwald  * 3. Neither the name of the copyright holders nor the names of
14*a705b1a2SMatthias Ringwald  *    contributors may be used to endorse or promote products derived
15*a705b1a2SMatthias Ringwald  *    from this software without specific prior written permission.
16*a705b1a2SMatthias Ringwald  * 4. Any redistribution, use, or modification is done solely for
17*a705b1a2SMatthias Ringwald  *    personal benefit and not for any commercial purpose or for
18*a705b1a2SMatthias Ringwald  *    monetary gain.
19*a705b1a2SMatthias Ringwald  *
20*a705b1a2SMatthias Ringwald  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21*a705b1a2SMatthias Ringwald  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22*a705b1a2SMatthias Ringwald  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23*a705b1a2SMatthias Ringwald  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24*a705b1a2SMatthias Ringwald  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25*a705b1a2SMatthias Ringwald  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26*a705b1a2SMatthias Ringwald  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27*a705b1a2SMatthias Ringwald  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28*a705b1a2SMatthias Ringwald  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29*a705b1a2SMatthias Ringwald  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30*a705b1a2SMatthias Ringwald  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31*a705b1a2SMatthias Ringwald  * SUCH DAMAGE.
32*a705b1a2SMatthias Ringwald  *
33*a705b1a2SMatthias Ringwald  * Please inquire about commercial licensing options at
34*a705b1a2SMatthias Ringwald  * [email protected]
35*a705b1a2SMatthias Ringwald  *
36*a705b1a2SMatthias Ringwald  */
37*a705b1a2SMatthias Ringwald 
38*a705b1a2SMatthias Ringwald /*
39*a705b1a2SMatthias Ringwald  *  hal_tick.h
40*a705b1a2SMatthias Ringwald  *
41*a705b1a2SMatthias Ringwald  *  Hardware abstraction layer for periodic ticks
42*a705b1a2SMatthias Ringwald  *
43*a705b1a2SMatthias Ringwald  */
44*a705b1a2SMatthias Ringwald 
45*a705b1a2SMatthias Ringwald #ifndef __HAL_TICK_H
46*a705b1a2SMatthias Ringwald #define __HAL_TICK_H
47*a705b1a2SMatthias Ringwald 
48*a705b1a2SMatthias Ringwald #include <stdint.h>
49*a705b1a2SMatthias Ringwald 
50*a705b1a2SMatthias Ringwald #if defined __cplusplus
51*a705b1a2SMatthias Ringwald extern "C" {
52*a705b1a2SMatthias Ringwald #endif
53*a705b1a2SMatthias Ringwald 
54*a705b1a2SMatthias Ringwald void hal_tick_init(void);
55*a705b1a2SMatthias Ringwald void hal_tick_set_handler(void (*tick_handler)(void));
56*a705b1a2SMatthias Ringwald int  hal_tick_get_tick_period_in_ms(void);
57*a705b1a2SMatthias Ringwald 
58*a705b1a2SMatthias Ringwald #if defined __cplusplus
59*a705b1a2SMatthias Ringwald }
60*a705b1a2SMatthias Ringwald #endif
61*a705b1a2SMatthias Ringwald #endif // __HAL_TICK_H
62