aboutsummaryrefslogtreecommitdiff
path: root/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/led_softblink
diff options
context:
space:
mode:
authorTrygve Laugstøl <trygvis@inamo.no>2018-08-23 17:08:59 +0200
committerTrygve Laugstøl <trygvis@inamo.no>2018-08-23 17:12:21 +0200
commit3061ecca3d0fdfb87dabbf5f63c9e06c2a30f53a (patch)
treeab49cc16ed0b853452c5c2ed2d3042416d628986 /thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/led_softblink
downloadiot-sensors-3061ecca3d0fdfb87dabbf5f63c9e06c2a30f53a.tar.gz
iot-sensors-3061ecca3d0fdfb87dabbf5f63c9e06c2a30f53a.tar.bz2
iot-sensors-3061ecca3d0fdfb87dabbf5f63c9e06c2a30f53a.tar.xz
iot-sensors-3061ecca3d0fdfb87dabbf5f63c9e06c2a30f53a.zip
o Initial import.HEADmaster
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/led_softblink')
-rw-r--r--thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/led_softblink/led_softblink.c232
-rw-r--r--thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/led_softblink/led_softblink.h171
2 files changed, 403 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/led_softblink/led_softblink.c b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/led_softblink/led_softblink.c
new file mode 100644
index 0000000..8156b96
--- /dev/null
+++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/led_softblink/led_softblink.c
@@ -0,0 +1,232 @@
+/**
+ * Copyright (c) 2015 - 2018, Nordic Semiconductor ASA
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form, except as embedded into a Nordic
+ * Semiconductor ASA integrated circuit in a product or a software update for
+ * such product, must reproduce the above copyright notice, this list of
+ * conditions and the following disclaimer in the documentation and/or other
+ * materials provided with the distribution.
+ *
+ * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * 4. This software, with or without modification, must only be used with a
+ * Nordic Semiconductor ASA integrated circuit.
+ *
+ * 5. Any software provided in binary form under this license must not be reverse
+ * engineered, decompiled, modified and/or disassembled.
+ *
+ * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
+ * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+ * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+#include "sdk_common.h"
+#if NRF_MODULE_ENABLED(LED_SOFTBLINK)
+#include <string.h>
+#include "led_softblink.h"
+#include "nrf_gpio.h"
+#include "app_timer.h"
+#include "nrf_assert.h"
+#include "low_power_pwm.h"
+
+/* Period for LED softblink PWM. */
+#define PWM_PERIOD UINT8_MAX
+
+/**@bref Structure to handle timer time-outs
+ *
+ */
+typedef struct
+{
+ bool leds_is_on; /**< Flag for indicating if LEDs are on. */
+ bool is_counting_up; /**< Flag for indicating if counter is incrementing or decrementing. */
+ nrfx_drv_state_t led_sb_state; /**< Indicates current state of instance. */
+ uint16_t duty_cycle; /**< Current pulse width. */
+ uint32_t bit_mask; /**< Mask of used pins. */
+ led_sb_init_params_t params; /**< Structure holding initialization parameters. */
+ low_power_pwm_config_t pwm_config; /**< Structure holding parameters for initializing low level layer. */
+ low_power_pwm_t pwm_instance; /**< Structure holding low-power PWM instance parameters. */
+}led_sb_context_t;
+
+APP_TIMER_DEF(m_led_softblink_timer);
+
+static led_sb_context_t m_led_sb = {0};
+
+/**@brief Timer event handler for softblink.
+ *
+ * @param[in] p_context General purpose pointer. Will be passed to the time-out handler
+ * when the timer expires.
+ *
+ */
+static void led_softblink_on_timeout(void * p_context)
+{
+ static int32_t pause_ticks;
+ ASSERT(m_led_sb.led_sb_state != NRFX_DRV_STATE_UNINITIALIZED);
+ ret_code_t err_code;
+
+ if (pause_ticks <= 0)
+ {
+ if (m_led_sb.is_counting_up)
+ {
+ if (m_led_sb.duty_cycle >= (m_led_sb.params.duty_cycle_max - m_led_sb.params.duty_cycle_step))
+ {
+ // Max PWM duty cycle is reached, start decrementing.
+ m_led_sb.is_counting_up = false;
+ m_led_sb.duty_cycle = m_led_sb.params.duty_cycle_max;
+ pause_ticks = m_led_sb.params.on_time_ticks ? m_led_sb.params.on_time_ticks + APP_TIMER_MIN_TIMEOUT_TICKS : 0;
+ }
+ else
+ {
+ m_led_sb.duty_cycle += m_led_sb.params.duty_cycle_step;
+ }
+ }
+ else
+ {
+ if (m_led_sb.duty_cycle <= (m_led_sb.params.duty_cycle_min + m_led_sb.params.duty_cycle_step))
+ {
+ // Min PWM duty cycle is reached, start incrementing.
+ m_led_sb.is_counting_up = true;
+ m_led_sb.duty_cycle = m_led_sb.params.duty_cycle_min;
+ pause_ticks = m_led_sb.params.off_time_ticks ? m_led_sb.params.off_time_ticks + APP_TIMER_MIN_TIMEOUT_TICKS : 0;
+ }
+ else
+ {
+ m_led_sb.duty_cycle -= m_led_sb.params.duty_cycle_step;
+ }
+ }
+ }
+ else
+ {
+ pause_ticks -= PWM_PERIOD;
+ }
+
+ err_code = low_power_pwm_duty_set(&m_led_sb.pwm_instance, m_led_sb.duty_cycle);
+
+ APP_ERROR_CHECK(err_code);
+}
+
+
+ret_code_t led_softblink_init(led_sb_init_params_t const * p_init_params)
+{
+ ret_code_t err_code;
+
+ ASSERT(m_led_sb.led_sb_state == NRFX_DRV_STATE_UNINITIALIZED);
+ ASSERT(p_init_params);
+
+ if ( (p_init_params->duty_cycle_max == 0) ||
+ (p_init_params->duty_cycle_max <= p_init_params->duty_cycle_min) ||
+ (p_init_params->duty_cycle_step == 0) ||
+ (p_init_params->leds_pin_bm == 0))
+ {
+ return NRF_ERROR_INVALID_PARAM;
+ }
+
+
+
+ memset(&m_led_sb, 0, sizeof(led_sb_context_t));
+ memcpy(&m_led_sb.params, p_init_params, sizeof(led_sb_init_params_t));
+
+ m_led_sb.is_counting_up = true;
+ m_led_sb.duty_cycle = p_init_params->duty_cycle_min + p_init_params->duty_cycle_step;
+ m_led_sb.leds_is_on = false;
+ m_led_sb.bit_mask = p_init_params->leds_pin_bm;
+
+ m_led_sb.pwm_config.active_high = m_led_sb.params.active_high;
+ m_led_sb.pwm_config.bit_mask = p_init_params->leds_pin_bm;
+ m_led_sb.pwm_config.p_port = p_init_params->p_leds_port;
+ m_led_sb.pwm_config.period = PWM_PERIOD;
+ m_led_sb.pwm_config.p_timer_id = &m_led_softblink_timer;
+
+ err_code = low_power_pwm_init( &m_led_sb.pwm_instance, &m_led_sb.pwm_config, led_softblink_on_timeout);
+
+ if (err_code == NRF_SUCCESS)
+ {
+ m_led_sb.led_sb_state = NRFX_DRV_STATE_INITIALIZED;
+ }
+ else
+ {
+ return err_code;
+ }
+
+ err_code = low_power_pwm_duty_set( &m_led_sb.pwm_instance, p_init_params->duty_cycle_min + p_init_params->duty_cycle_step);
+
+ return err_code;
+}
+
+
+ret_code_t led_softblink_start(uint32_t leds_pin_bit_mask)
+{
+ ret_code_t err_code;
+
+ ASSERT(m_led_sb.led_sb_state == NRFX_DRV_STATE_INITIALIZED);
+
+ err_code = low_power_pwm_start(&m_led_sb.pwm_instance, leds_pin_bit_mask);
+
+ return err_code;
+}
+
+
+ret_code_t led_softblink_stop(void)
+{
+ ret_code_t err_code;
+
+ err_code = low_power_pwm_stop(&m_led_sb.pwm_instance);
+
+ return err_code;
+}
+
+
+void led_softblink_off_time_set(uint32_t off_time_ticks)
+{
+ ASSERT(m_led_sb.led_sb_state != NRFX_DRV_STATE_UNINITIALIZED);
+
+ m_led_sb.params.off_time_ticks = off_time_ticks;
+}
+
+
+void led_softblink_on_time_set(uint32_t on_time_ticks)
+{
+ ASSERT(m_led_sb.led_sb_state != NRFX_DRV_STATE_UNINITIALIZED);
+
+ m_led_sb.params.on_time_ticks = on_time_ticks;
+}
+
+
+ret_code_t led_softblink_uninit(void)
+{
+ ASSERT(m_led_sb.led_sb_state != NRFX_DRV_STATE_UNINITIALIZED);
+
+ ret_code_t err_code;
+
+ err_code = led_softblink_stop();
+
+ if (err_code == NRF_SUCCESS)
+ {
+ m_led_sb.led_sb_state = NRFX_DRV_STATE_UNINITIALIZED;
+ }
+ else
+ {
+ return err_code;
+ }
+
+ memset(&m_led_sb, 0, sizeof(m_led_sb));
+
+ return NRF_SUCCESS;
+}
+#endif //NRF_MODULE_ENABLED(LED_SOFTBLINK)
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/led_softblink/led_softblink.h b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/led_softblink/led_softblink.h
new file mode 100644
index 0000000..936edba
--- /dev/null
+++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/led_softblink/led_softblink.h
@@ -0,0 +1,171 @@
+/**
+ * Copyright (c) 2015 - 2018, Nordic Semiconductor ASA
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form, except as embedded into a Nordic
+ * Semiconductor ASA integrated circuit in a product or a software update for
+ * such product, must reproduce the above copyright notice, this list of
+ * conditions and the following disclaimer in the documentation and/or other
+ * materials provided with the distribution.
+ *
+ * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * 4. This software, with or without modification, must only be used with a
+ * Nordic Semiconductor ASA integrated circuit.
+ *
+ * 5. Any software provided in binary form under this license must not be reverse
+ * engineered, decompiled, modified and/or disassembled.
+ *
+ * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
+ * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+ * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+/** @file
+ *
+ * @defgroup led_softblink LED softblink
+ * @{
+ * @ingroup app_common
+ *
+ * @brief Module for generating a changing pulse-width modulated output signal that is used to smoothly blink LEDs.
+ *
+ * @details This module provides an LED softblink implementation using timers and GPIO.
+ *
+ * LED softblink needs one timer. It can use any number of output channels that are available.
+ *
+ * Only one instance of LED softblink can run at a time.
+ */
+
+#ifndef LED_SOFTBLINK_H__
+#define LED_SOFTBLINK_H__
+
+#include <stdbool.h>
+#include <stdint.h>
+#include "sdk_errors.h"
+#include "nrf_gpio.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Structure holding the initialization parameters.
+ */
+typedef struct
+{
+ bool active_high; /**< Activate negative polarity. */
+ uint8_t duty_cycle_max; /**< Maximum impulse width. */
+ uint8_t duty_cycle_min; /**< Minimum impulse width. */
+ uint8_t duty_cycle_step; /**< Cycle step. */
+ uint32_t off_time_ticks; /**< Ticks to stay in low impulse state. */
+ uint32_t on_time_ticks; /**< Ticks to stay in high impulse state. */
+ uint32_t leds_pin_bm; /**< Mask of used LEDs. */
+ NRF_GPIO_Type * p_leds_port; /**< Port of used LEDs mask. */
+}led_sb_init_params_t;
+
+/**
+ * @name Default settings
+ * @brief Default settings for LED softblink.
+ * @{
+ */
+#define LED_SB_INIT_PARAMS_ACTIVE_HIGH false
+#define LED_SB_INIT_PARAMS_DUTY_CYCLE_MAX 220
+#define LED_SB_INIT_PARAMS_DUTY_CYCLE_MIN 0
+#define LED_SB_INIT_PARAMS_DUTY_CYCLE_STEP 5
+#define LED_SB_INIT_PARAMS_OFF_TIME_TICKS 65536
+#define LED_SB_INIT_PARAMS_ON_TIME_TICKS 0
+#define LED_SB_INIT_PARAMS_LEDS_PIN_BM(mask) (mask)
+#define LED_SB_INIT_PARAMS_LEDS_PORT NRF_GPIO
+/** @} */
+
+/**
+ * @brief LED softblink default configuration.
+ */
+#define LED_SB_INIT_DEFAULT_PARAMS(mask) \
+{ \
+ .active_high = LED_SB_INIT_PARAMS_ACTIVE_HIGH, \
+ .duty_cycle_max = LED_SB_INIT_PARAMS_DUTY_CYCLE_MAX, \
+ .duty_cycle_min = LED_SB_INIT_PARAMS_DUTY_CYCLE_MIN, \
+ .duty_cycle_step = LED_SB_INIT_PARAMS_DUTY_CYCLE_STEP, \
+ .off_time_ticks = LED_SB_INIT_PARAMS_OFF_TIME_TICKS, \
+ .on_time_ticks = LED_SB_INIT_PARAMS_ON_TIME_TICKS, \
+ .leds_pin_bm = LED_SB_INIT_PARAMS_LEDS_PIN_BM(mask), \
+ .p_leds_port = LED_SB_INIT_PARAMS_LEDS_PORT \
+}
+
+/**
+ * @brief Function for initializing LED softblink.
+ *
+ * @param[in] p_init_params Pointer to the initialization structure.
+ *
+ * @return Values returned by @ref app_timer_create.
+ */
+ret_code_t led_softblink_init(led_sb_init_params_t const * p_init_params);
+
+/**
+ * @brief Function for starting to blink LEDs.
+ *
+ * @param[in] leds_pin_bit_mask Bit mask containing the pins for the LEDs to be blinked.
+ *
+ * @return Values returned by @ref app_timer_start.
+ */
+ret_code_t led_softblink_start(uint32_t leds_pin_bit_mask);
+
+/**
+ * @brief Function for stopping to blink LEDs.
+ *
+ * @return Values returned by @ref app_timer_stop.
+ */
+ret_code_t led_softblink_stop(void);
+
+/**
+ * @brief Function for setting the off time.
+ *
+ * This function configures the time that the LEDs will be off between each blink.
+ *
+ * @param[in] off_time_ticks Off time in ticks.
+ *
+ */
+void led_softblink_off_time_set(uint32_t off_time_ticks);
+
+/**
+ * @brief Function for setting the on time.
+ *
+ * This function configures the time that the LEDs will be on between each blink.
+ *
+ * @param[in] on_time_ticks On time in ticks.
+ *
+ */
+void led_softblink_on_time_set(uint32_t on_time_ticks);
+
+/**
+ * @brief Function for uninitializing LED softblink.
+ *
+ * @retval NRF_SUCCESS If LED softblink was uninitialized successfully.
+ */
+ret_code_t led_softblink_uninit(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // LED_SOFTBLINK_H__
+
+/** @} */
+