aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/src/pwm.c
blob: ad3c1572884489e5e6e73ea21841442e15f39e61 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/*
    ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file PWM.c
 * @brief PWM Driver code.
 * @addtogroup PWM
 * @{
 */

#include "ch.h"
#include "hal.h"

#if CH_HAL_USE_PWM || defined(__DOXYGEN__)

/**
 * @brief PWM Driver initialization.
 */
void pwmInit(void) {

  pwm_lld_init();
}

/**
 * @brief Initializes the standard part of a @p PWMDriver structure.
 *
 * @param[in] pwmp      pointer to a @p PWMDriver object
 */
void pwmObjectInit(PWMDriver *pwmp) {

  pwmp->pd_state    = PWM_STOP;
  pwmp->pd_config   = NULL;
}

/**
 * @brief Configures and activates the PWM peripheral.
 *
 * @param[in] pwmp      pointer to a @p PWMDriver object
 * @param[in] config    pointer to a @p PWMConfig object
 */
void pwmStart(PWMDriver *pwmp, const PWMConfig *config) {

  chDbgCheck((pwmp != NULL) && (config != NULL), "pwmStart");

  chSysLock();
  chDbgAssert((pwmp->pd_state == PWM_STOP) || (pwmp->pd_state == PWM_READY),
              "pwmStart(), #1",
              "invalid state");
  pwmp->pd_config = config;
  pwm_lld_start(pwmp);
  pwmp->pd_state = PWM_READY;
  chSysUnlock();
}

/**
 * @brief Deactivates the PWM peripheral.
 *
 * @param[in] pwmp      pointer to a @p PWMDriver object
 */
void pwmStop(PWMDriver *pwmp) {

  chDbgCheck(pwmp != NULL, "pwmStop");

  chSysLock();
  chDbgAssert((pwmp->pd_state == PWM_STOP) || (pwmp->pd_state == PWM_READY),
              "pwmStop(), #1",
              "invalid state");
  pwm_lld_stop(pwmp);
  pwmp->pd_state = PWM_STOP;
  chSysUnlock();
}

/**
 * @brief Setups a PWM channel.
 * @details Associates a configuration to a PWM channel, this operation is
 *          required before a channel can be enabled using
 *          @p pwmEnableChannel().
 *
 * @param[in] pwmp      pointer to a @p PWMDriver object
 * @param[in] channel   PWM channel identifier
 * @param[in] pccp      pointer to a @p PWMChannelConfig object
 */
void pwmSetupChannel(PWMDriver *pwmp, pwmchannel_t channel,
                     const PWMChannelConfig *pccp) {

  chDbgCheck((pwmp != NULL) && (channel < PWM_CHANNELS) && (pccp != NULL),
             "pwmSetupChannel");

  chSysLock();
  chDbgAssert((pwmp->pd_state == PWM_READY) &&
              !pwm_lld_is_enabled(pwmp, channel),
              "pwmSetupChannel(), #1", "invalid state");
  pwmp->pd_channel_configs[channel] = pccp;
  pwm_lld_setup_channel(pwmp, channel);
  chSysUnlock();
}

/**
 * @brief Enables a PWM channel.
 *
 * @param[in] pwmp      pointer to a @p PWMDriver object
 * @param[in] channel   PWM channel identifier
 * @param[in] width     PWM pulse width as clock pulses number
 */
void pwmEnableChannel(PWMDriver *pwmp,
                      pwmchannel_t channel,
                      pwmcnt_t width) {

  chDbgCheck((pwmp != NULL) && (channel < PWM_CHANNELS),
             "pwmEnableChannel");

  chSysLock();
  chDbgAssert((pwmp->pd_state == PWM_READY) &&
              (pwmp->pd_channel_configs[channel] != NULL),
              "pwmEnableChannel(), #1", "invalid state");
  pwm_lld_enable_channel(pwmp, channel, width);
  chSysUnlock();
}

/**
 * @brief Disables a PWM channel.
 * @details The channel is disabled and its output line returned to the
 *          idle state.
 *
 * @param[in] pwmp      pointer to a @p PWMDriver object
 * @param[in] channel   PWM channel identifier
 */
void pwmDisableChannel(PWMDriver *pwmp, pwmchannel_t channel) {

  chDbgCheck((pwmp != NULL) && (channel < PWM_CHANNELS),
             "pwmEnableChannel");

  chSysLock();
  chDbgAssert((pwmp->pd_state == PWM_READY) &&
              (pwmp->pd_channel_configs[channel] != NULL),
              "pwmDisableChannel(), #1", "invalid state");
  pwm_lld_disable_channel(pwmp, channel);
  chSysUnlock();
}

#endif /* CH_HAL_USE_PWM */

/** @} */