123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209 |
- /**
- * Copyright (c) 2015 - 2020, 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 low_power_pwm Low-power PWM
- * @{
- * @ingroup app_common
- *
- * @brief Module for generating a low-power pulse-width modulated output signal.
- *
- * This module provides a low-power PWM implementation using app_timers and GPIO.
- *
- * Each low-power PWM instance utilizes one app_timer. This means it runs on RTC
- * and does not require HFCLK to be running. There can be any number of output
- * channels per instance.
- */
- #ifndef LOW_POWER_PWM_H__
- #define LOW_POWER_PWM_H__
- #include <nrfx.h>
- #include "app_timer.h"
- #include "sdk_errors.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- /**
- * @brief Event types.
- */
- typedef enum
- {
- LOW_POWER_PWM_EVENT_PERIOD = 0,
- LOW_POWER_PWM_EVENT_DUTY_CYCLE
- }low_power_pwm_evt_type_t;
- /**@brief Application time-out handler type. */
- typedef void (*low_power_pwm_timeout_user)(void * p_context, low_power_pwm_evt_type_t evt_type);
- /**
- * @brief Structure holding the initialization parameters.
- */
- typedef struct
- {
- bool active_high; /**< Activate negative polarity. */
- uint8_t period; /**< Width of the low_power_pwm period. */
- NRF_GPIO_Type * p_port; /**< Port used to work on selected mask. */
- uint32_t bit_mask; /**< Pins to be initialized. */
- app_timer_id_t const * p_timer_id; /**< Pointer to the timer ID of low_power_pwm. */
- } low_power_pwm_config_t;
- /**
- * @name Default settings
- * @{
- *
- * @brief Default parameters for the @ref low_power_pwm_config_t structure.
- *
- */
- #define LOW_POWER_PWM_CONFIG_ACTIVE_HIGH false
- #define LOW_POWER_PWM_CONFIG_PERIOD UINT8_MAX
- #define LOW_POWER_PWM_CONFIG_PORT NRF_GPIO
- #define LOW_POWER_PWM_CONFIG_BIT_MASK(mask) (mask)
- /** @} */
- /**
- * @brief Low-power PWM default configuration.
- */
- #define LOW_POWER_PWM_DEFAULT_CONFIG(mask) \
- { \
- .active_high = LOW_POWER_PWM_CONFIG_ACTIVE_HIGH , \
- .period = LOW_POWER_PWM_CONFIG_PERIOD , \
- .p_port = LOW_POWER_PWM_CONFIG_PORT, \
- .bit_mask = LOW_POWER_PWM_CONFIG_BIT_MASK(mask) \
- }
- /**
- * @cond (NODOX)
- * @defgroup low_power_pwm_internal Auxiliary internal types declarations
- * @brief Module for internal usage inside the library only.
- * @details These definitions are available to the user, but they should not
- * be accessed directly. Use @ref low_power_pwm_duty_set instead.
- * @{
- *
- */
- /**
- * @brief Structure holding parameters of a given low-power PWM instance.
- */
- struct low_power_pwm_s
- {
- bool active_high; /**< Activate negative polarity. */
- bool pin_is_on; /**< Indicates the current state of the pin. */
- uint8_t period; /**< Width of the low_power_pwm period. */
- uint8_t duty_cycle; /**< Width of high pulse. */
- nrfx_drv_state_t pwm_state; /**< Indicates the current state of the PWM instance. */
- uint32_t bit_mask; /**< Pins to be initialized. */
- uint32_t bit_mask_toggle; /**< Pins to be toggled. */
- uint32_t timeout_ticks; /**< Value to start the next app_timer. */
- low_power_pwm_evt_type_t evt_type; /**< Slope that triggered time-out. */
- app_timer_timeout_handler_t handler; /**< User handler to be called in the time-out handler. */
- app_timer_id_t const * p_timer_id; /**< Pointer to the timer ID of low_power_pwm. */
- NRF_GPIO_Type * p_port; /**< Port used with pin bit mask. */
- };
- /** @}
- * @endcond
- */
- /**
- * @brief Internal structure holding parameters of a low-power PWM instance.
- */
- typedef struct low_power_pwm_s low_power_pwm_t;
- /**
- * @brief Function for initializing a low-power PWM instance.
- *
- * @param[in] p_pwm_instance Pointer to the instance to be started.
- * @param[in] p_pwm_config Pointer to the configuration structure.
- * @param[in] handler User function to be called in case of time-out.
- *
- * @return Values returned by @ref app_timer_create.
- */
- ret_code_t low_power_pwm_init(low_power_pwm_t * p_pwm_instance,
- low_power_pwm_config_t const * p_pwm_config,
- app_timer_timeout_handler_t handler);
- /**
- * @brief Function for starting a low-power PWM instance.
- *
- * @param[in] p_pwm_instance Pointer to the instance to be started.
- * @param[in] pins_bit_mask Bit mask of pins to be started.
- *
- * @return Values returned by @ref app_timer_start.
- */
- ret_code_t low_power_pwm_start(low_power_pwm_t * p_pwm_instance,
- uint32_t pins_bit_mask);
- /**
- * @brief Function for stopping a low-power PWM instance.
- *
- * @param[in] p_pwm_instance Pointer to the instance to be stopped.
- *
- * @return Values returned by @ref app_timer_stop.
- */
- ret_code_t low_power_pwm_stop(low_power_pwm_t * p_pwm_instance);
- /**
- * @brief Function for setting a new high pulse width for a given instance.
- *
- * This function can be called from the timer handler.
- *
- * @param[in] p_pwm_instance Pointer to the instance to be changed.
- * @param[in] duty_cycle New high pulse width. 0 means that the pin is always off. 255 means that it is always on.
- *
- * @retval NRF_SUCCESS If the function completed successfully.
- * @retval NRF_ERROR_INVALID_PARAM If the function returned an error because of invalid parameters.
- */
- ret_code_t low_power_pwm_duty_set(low_power_pwm_t * p_pwm_instance, uint8_t duty_cycle);
- #ifdef __cplusplus
- }
- #endif
- #endif // LOW_POWER_PWM_H__
- /** @} */
|