Loading...
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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 | /*
* Copyright (c) 2016 Intel Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @brief Public PWM Driver APIs
*/
#ifndef __PWM_H__
#define __PWM_H__
/**
* @brief PWM Interface
* @defgroup pwm_interface PWM Interface
* @ingroup io_interfaces
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
#define PWM_ACCESS_BY_PIN 0
#define PWM_ACCESS_ALL 1
#include <errno.h>
#include <stdint.h>
#include <stddef.h>
#include <device.h>
/**
* @typedef pwm_config_t
* @brief Callback API upon configuration
* See @a pwm_pin_configure() for argument description
*/
typedef int (*pwm_config_t)(struct device *dev, int access_op,
uint32_t pwm, int flags);
/**
* @typedef pwm_set_values_t
* @brief Callback API upon setting PIN values
* See @a pwm_pin_set_values() for argument description
*/
typedef int (*pwm_set_values_t)(struct device *dev, int access_op,
uint32_t pwm, uint32_t on, uint32_t off);
/**
* @typedef pwm_set_duty_cycle_t
* @brief Callback API upon setting the duty cycle
* See @a pwm_pin_set_duty_cycle() for argument description
*/
typedef int (*pwm_set_duty_cycle_t)(struct device *dev, int access_op,
uint32_t pwm, uint8_t duty);
/**
* @typedef pwm_set_phase_t
* @brief Callback API upon setting the phase
* See @a pwm_pin_set_phase() for argument description
*/
typedef int (*pwm_set_phase_t)(struct device *dev, int access_op,
uint32_t pwm, uint8_t phase);
/**
* @typedef pwm_set_period_t
* @brief Callback API upon setting the period
* See @a pwm_pin_set_period() for argument description
*/
typedef int (*pwm_set_period_t)(struct device *dev, int access_op,
uint32_t pwm, uint32_t period);
/** @brief PWM driver API definition. */
struct pwm_driver_api {
pwm_config_t config;
pwm_set_values_t set_values;
pwm_set_period_t set_period;
pwm_set_duty_cycle_t set_duty_cycle;
pwm_set_phase_t set_phase;
};
/**
* @brief Configure a single PWM output.
*
* @param dev Pointer to the device structure for the driver instance.
* @param pwm PWM output.
* @param flags PWM configuration flags.
*
* @retval 0 If successful,
* @retval Negative errno code if failure.
*/
static inline int pwm_pin_configure(struct device *dev, uint8_t pwm,
int flags)
{
struct pwm_driver_api *api;
api = (struct pwm_driver_api *)dev->driver_api;
return api->config(dev, PWM_ACCESS_BY_PIN, pwm, flags);
}
/**
* @brief Set the ON/OFF values for a single PWM output.
*
* @param dev Pointer to the device structure for the driver instance.
* @param pwm PWM output.
* @param on ON value set to the PWM.
* @param off OFF value set to the PWM.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int pwm_pin_set_values(struct device *dev, uint32_t pwm,
uint32_t on, uint32_t off)
{
struct pwm_driver_api *api;
api = (struct pwm_driver_api *)dev->driver_api;
return api->set_values(dev, PWM_ACCESS_BY_PIN, pwm, on, off);
}
/**
* @brief Set the period of a single PWM output.
*
* It is optional to call this API. If not called, there is a default
* period.
*
* @param dev Pointer to the device structure for the driver instance.
* @param pwm PWM output.
* @param period Period duration of the cycle to set in microseconds
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int pwm_pin_set_period(struct device *dev, uint32_t pwm,
uint32_t period)
{
struct pwm_driver_api *api;
api = (struct pwm_driver_api *)dev->driver_api;
return api->set_period(dev, PWM_ACCESS_BY_PIN, pwm, period);
}
/**
* @brief Set the duty cycle of a single PWM output.
*
* This routine overrides any ON/OFF values set before.
*
* @param dev Pointer to the device structure for the driver instance.
* @param pwm PWM output.
* @param duty Duty cycle to set to the PWM in %, for example,
* 50 sets to 50%.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int pwm_pin_set_duty_cycle(struct device *dev, uint32_t pwm,
uint8_t duty)
{
struct pwm_driver_api *api;
api = (struct pwm_driver_api *)dev->driver_api;
return api->set_duty_cycle(dev, PWM_ACCESS_BY_PIN, pwm, duty);
}
/**
* @brief Set the phase of a single PWM output.
*
* This routine sets the delay before pulses.
*
* @param dev Pointer to the device structure for the driver instance.
* @param pwm PWM output.
* @param phase The number of clock ticks to delay before the start of pulses.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int pwm_pin_set_phase(struct device *dev, uint32_t pwm,
uint8_t phase)
{
struct pwm_driver_api *api;
api = (struct pwm_driver_api *)dev->driver_api;
if ((api != NULL) && (api->set_phase != NULL)) {
return api->set_phase(dev, PWM_ACCESS_BY_PIN, pwm, phase);
}
return -ENOTSUP;
}
/**
* @brief Configure all the PWM outputs.
*
* @param dev Pointer to the device structure for the driver instance.
* @param flags PWM configuration flags.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int pwm_all_configure(struct device *dev, int flags)
{
struct pwm_driver_api *api;
api = (struct pwm_driver_api *)dev->driver_api;
return api->config(dev, PWM_ACCESS_ALL, 0, flags);
}
/**
* @brief Set the ON/OFF values for all PWM outputs.
*
* @param dev Pointer to the device structure for the driver instance.
* @param on ON value set to the PWM.
* @param off OFF value set to the PWM.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int pwm_all_set_values(struct device *dev,
uint32_t on, uint32_t off)
{
struct pwm_driver_api *api;
api = (struct pwm_driver_api *)dev->driver_api;
return api->set_values(dev, PWM_ACCESS_ALL, 0, on, off);
}
/**
* @brief Set the period of all PWM outputs.
*
* It is optional to call this API. If not called, there is a default
* period.
*
* @param dev Pointer to the device structure for the driver instance.
* @param period Period duration of the cycle to set in microseconds
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int pwm_all_period(struct device *dev, uint32_t period)
{
struct pwm_driver_api *api;
api = (struct pwm_driver_api *)dev->driver_api;
return api->set_period(dev, PWM_ACCESS_ALL, 0, period);
}
/**
* @brief Set the duty cycle of all PWM outputs.
*
* This overrides any ON/OFF values being set before.
*
* @param dev Pointer to the device structure for the driver instance.
* @param duty Duty cycle to set to the PWM in %, for example,
* 50 sets to 50%.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int pwm_all_set_duty_cycle(struct device *dev, uint8_t duty)
{
struct pwm_driver_api *api;
api = (struct pwm_driver_api *)dev->driver_api;
return api->set_duty_cycle(dev, PWM_ACCESS_ALL, 0, duty);
}
/**
* @brief Set the phase of all PWM outputs.
*
* This routine sets the delay before pulses.
*
* @param dev Pointer to the device structure for the driver instance.
* @param phase The number of clock ticks to delay before the start of pulses.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int pwm_all_set_phase(struct device *dev, uint8_t phase)
{
struct pwm_driver_api *api;
api = (struct pwm_driver_api *)dev->driver_api;
if ((api != NULL) && (api->set_phase != NULL)) {
return api->set_phase(dev, PWM_ACCESS_ALL, 0, phase);
}
return -ENOTSUP;
}
#ifdef __cplusplus
}
#endif
/**
* @}
*/
#endif /* __PWM_H__ */
|