nRF5 SDK for Mesh v5.0.0
simple_hal.h
1 /* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without modification,
5  * are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form, except as embedded into a Nordic
11  * Semiconductor ASA integrated circuit in a product or a software update for
12  * such product, must reproduce the above copyright notice, this list of
13  * conditions and the following disclaimer in the documentation and/or other
14  * materials provided with the distribution.
15  *
16  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
17  * contributors may be used to endorse or promote products derived from this
18  * software without specific prior written permission.
19  *
20  * 4. This software, with or without modification, must only be used with a
21  * Nordic Semiconductor ASA integrated circuit.
22  *
23  * 5. Any software provided in binary form under this license must not be reverse
24  * engineered, decompiled, modified and/or disassembled.
25  *
26  * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
27  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28  * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
29  * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
30  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
32  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
35  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef SIMPLE_HAL_H__
39 #define SIMPLE_HAL_H__
40 
41 #include <stdint.h>
42 #include <stdbool.h>
43 #include "hal.h"
44 #include "boards.h"
45 #include "utils.h"
46 
57 #define HAL_BUTTON_PRESS_DEBOUNCE_INTERVAL MS_TO_US(400)
58 
60 #define HAL_LED_BLINK_PERIOD_MIN_MS (20)
61 
63 #define LED_MASK_STATE_OFF (false)
64 
65 #define LED_MASK_STATE_ON (true)
66 
68 #define HAL_LED_MASK ((1 << LEDS_NUMBER) - 1)
69 
70 #if (LEDS_NUMBER == 1)
71  #define HAL_LED_MASK_HALF (HAL_LED_MASK)
72  #define HAL_LED_MASK_LOWER_HALF (HAL_LED_MASK)
73  #define HAL_LED_MASK_UPPER_HALF (HAL_LED_MASK)
74 #else
75  #define HAL_LED_MASK_HALF ((1 << (LEDS_NUMBER/2)) - 1)
76  #define HAL_LED_MASK_LOWER_HALF (HAL_LED_MASK_HALF)
77  #define HAL_LED_MASK_UPPER_HALF (HAL_LED_MASK ^ HAL_LED_MASK_HALF)
78 #endif
79 
81 #define BUTTON_BOARD (defined(BOARD_PCA10040) || defined(BOARD_PCA10028) || defined(BOARD_PCA10056) \
82  || defined(BOARD_PCA10100) || defined(BOARD_PCA10059)) //lint -e491 // Suppress "non-standard use of 'defined' preprocessor operator"
83 
88 typedef void (*hal_button_handler_cb_t)(uint32_t button_number);
89 
91 void hal_leds_init(void);
92 
106 
107 
113 void hal_led_pin_set(uint32_t pin, bool value);
114 
120 void hal_led_mask_set(uint32_t led_mask, bool value);
121 
130 bool hal_led_pin_get(uint32_t pin);
131 
144 void hal_led_blink_ms(uint32_t pin_mask, uint32_t delay_ms, uint32_t blink_count);
145 
151 void hal_led_blink_stop(void);
152 
156 #endif /* SIMPLE_HAL_H__ */
void hal_led_pin_set(uint32_t pin, bool value)
Sets the LED for the given PIN.
void hal_led_blink_stop(void)
Stops blinking the LEDs (previously started by hal_led_blink_ms).
uint32_t hal_buttons_init(hal_button_handler_cb_t cb)
Initializes the buttons on a DK.
void(* hal_button_handler_cb_t)(uint32_t button_number)
Button event handler callback type.
Definition: simple_hal.h:88
void hal_led_blink_ms(uint32_t pin_mask, uint32_t delay_ms, uint32_t blink_count)
Blinks (one toggle cycle) pin_mask a specified number of times.
bool hal_led_pin_get(uint32_t pin)
Gets the current state of a (LED) pin.
void hal_led_mask_set(uint32_t led_mask, bool value)
Sets the LEDs for the given mask.
void hal_leds_init(void)
Initializes the LEDs.

Documentation feedback | Developer Zone | Subscribe | Updated