nRF5 SDK for Mesh v5.0.0
pwm_utils.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 PWM_UTILS_H__
39 #define PWM_UTILS_H__
40 
41 #include <stdint.h>
42 
43 #include "nrf_mesh_config_core.h"
44 #include "app_pwm.h"
45 
59 typedef struct
60 {
62  const app_pwm_t * p_pwm;
64  app_pwm_config_t * p_pwm_config;
66  uint8_t channel;
67 
69  uint16_t pwm_ticks_max;
71 
72 
79 
89 void pwm_utils_level_set(pwm_utils_contex_t * p_ctx, int16_t level);
90 
100 int16_t pwm_utils_level_get(pwm_utils_contex_t * p_ctx);
101 
115 uint32_t pwm_utils_level_set_unsigned(pwm_utils_contex_t * p_ctx, uint16_t level);
116 
127 
130 #endif
uint16_t pwm_utils_level_get_unsigned(pwm_utils_contex_t *p_ctx)
Get the uint16 value corresponding to the PWM duty cycle.
uint32_t pwm_utils_level_set_unsigned(pwm_utils_contex_t *p_ctx, uint16_t level)
Set the PWM duty cycle corresponding to given uint16 value.
uint16_t pwm_ticks_max
Internal.
Definition: pwm_utils.h:69
void pwm_utils_level_set(pwm_utils_contex_t *p_ctx, int16_t level)
Set the PWM duty cycle corresponding to given int16 value.
const app_pwm_t * p_pwm
Pointer to a PWM instance created using APP_PWM_INSTANCE macro.
Definition: pwm_utils.h:62
uint8_t channel
Channel number to use.
Definition: pwm_utils.h:66
int16_t pwm_utils_level_get(pwm_utils_contex_t *p_ctx)
Get the int16 value corresponding to the PWM duty cycle.
app_pwm_config_t * p_pwm_config
Pointer to a app_pwm_config_t PWM configuration structure.
Definition: pwm_utils.h:64
void pwm_utils_enable(pwm_utils_contex_t *p_ctx)
Enables the PWM channel.
Context structure for defining application specific instance of PWM peripheral to be used with this m...
Definition: pwm_utils.h:59

Documentation feedback | Developer Zone | Subscribe | Updated