zephyrproject-rtos/zephyr
0
0
Fork 0
mirror of https://github.com/zephyrproject-rtos/zephyr synced 2025-08-10 23:37:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
5a0b4976d9
zephyr/include/pwm.h
Kumar Gala cc334c7273 Convert remaining code to using newly introduced integer sized types 
Convert code to use u{8,16,32,64}_t and s{8,16,32,64}_t instead of C99
integer types.  This handles the remaining includes and kernel, plus
touching up various points that we skipped because of include
dependancies.  We also convert the PRI printf formatters in the arch
code over to normal formatters.

Jira: ZEP-2051

Change-Id: Iecbb12601a3ee4ea936fd7ddea37788a645b08b0
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-04-21 11:38:23 -05:00

425 lines
12 KiB
C
Raw Blame History

/*
* Copyright (c) 2016 Intel Corporation.
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @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 <zephyr/types.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,
u32_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,
u32_t pwm, u32_t on, u32_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,
u32_t pwm, u8_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,
u32_t pwm, u8_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,
u32_t pwm, u32_t period);
/**
* @typedef pwm_pin_set_t
* @brief Callback API upon setting the pin
* See @a pwm_pin_set_cycles() for argument description
*/
typedef int (*pwm_pin_set_t)(struct device *dev, u32_t pwm,
u32_t period_cycles, u32_t pulse_cycles);
/**
* @typedef pwm_get_cycles_per_sec_t
* @brief Callback API upon getting cycles per second
* See @a pwm_get_cycles_per_sec() for argument description
*/
typedef int (*pwm_get_cycles_per_sec_t)(struct device *dev, u32_t pwm,
u64_t *cycles);
/** @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;
pwm_pin_set_t pin_set;
pwm_get_cycles_per_sec_t get_cycles_per_sec;
};
/**
* @brief Set the period and pulse width for a single PWM output.
*
* @param dev Pointer to the device structure for the driver instance.
* @param pwm PWM pin.
* @param period Period (in clock cycle) set to the PWM. HW specific.
* @param pulse Pulse width (in clock cycle) set to the PWM. HW specific.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int pwm_pin_set_cycles(struct device *dev, u32_t pwm,
u32_t period, u32_t pulse)
{
struct pwm_driver_api *api;
api = (struct pwm_driver_api *)dev->driver_api;
return api->pin_set(dev, pwm, period, pulse);
}
/**
* @brief Set the period and pulse width for a single PWM output.
*
* @param dev Pointer to the device structure for the driver instance.
* @param pwm PWM pin.
* @param period Period (in micro second) set to the PWM.
* @param pulse Pulse width (in micro second) set to the PWM.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int pwm_pin_set_usec(struct device *dev, u32_t pwm,
u32_t period, u32_t pulse)
{
struct pwm_driver_api *api;
u64_t period_cycles, pulse_cycles, cycles_per_sec;
api = (struct pwm_driver_api *)dev->driver_api;
if (api->get_cycles_per_sec(dev, pwm, &cycles_per_sec) != 0) {
return -EIO;
}
period_cycles = (period * cycles_per_sec) / USEC_PER_SEC;
if (period_cycles >= ((u64_t)1 << 32)) {
return -ENOTSUP;
}
pulse_cycles = (pulse * cycles_per_sec) / USEC_PER_SEC;
if (pulse_cycles >= ((u64_t)1 << 32)) {
return -ENOTSUP;
}
return api->pin_set(dev, pwm, (u32_t)period_cycles,
(u32_t)pulse_cycles);
}
/**
* @brief Get the clock rate (cycles per second) for a single PWM output.
*
* @param dev Pointer to the device structure for the driver instance.
* @param pwm PWM pin.
* @param cycles Pointer to the memory to store clock rate (cycles per sec).
* HW specific.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int pwm_get_cycles_per_sec(struct device *dev, u32_t pwm,
u64_t *cycles)
{
struct pwm_driver_api *api;
api = (struct pwm_driver_api *)dev->driver_api;
return api->get_cycles_per_sec(dev, pwm, cycles);
}
/**
* @brief Configure a single PWM output.
*
* @deprecated This API will be deprecated.
*
* @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 __deprecated pwm_pin_configure(struct device *dev,
u8_t pwm, int flags)
{
const struct pwm_driver_api *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.
*
* @deprecated This API will be deprecated. Please use the new API
* pwm_pin_set_cycles.
*
* @param dev Pointer to the device structure for the driver instance.
* @param pwm PWM output.
* @param on ON value (number of timer count) set to the PWM. HW specific.
* How far from the beginning of a PWM cycle the PWM pulse starts.
* @param off OFF value (number of timer count) set to the PWM. HW specific.
* How far from the beginning of a PWM cycle the PWM pulse stops.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int __deprecated pwm_pin_set_values(struct device *dev,
u32_t pwm, u32_t on,
u32_t off)
{
const struct pwm_driver_api *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.
*
* @deprecated This API will be deprecated. Please use the new API
* pwm_pin_set_usec.
*
* 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 __deprecated pwm_pin_set_period(struct device *dev,
u32_t pwm,
u32_t period)
{
const struct pwm_driver_api *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.
*
* @deprecated This API will be deprecated. Please use the new API
* pwm_pin_set_cycles or pwm_pin_set_usec.
*
* 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 __deprecated pwm_pin_set_duty_cycle(struct device *dev,
u32_t pwm,
u8_t duty)
{
const struct pwm_driver_api *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.
*
* @deprecated This API will be deprecated. Set_phase will not be supported
* any more.
*
* 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 __deprecated pwm_pin_set_phase(struct device *dev,
u32_t pwm, u8_t phase)
{
const struct pwm_driver_api *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.
*
* @deprecated This API will be deprecated.
*
* @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 __deprecated pwm_all_configure(struct device *dev, int flags)
{
const struct pwm_driver_api *api = dev->driver_api;
return api->config(dev, PWM_ACCESS_ALL, 0, flags);
}
/**
* @brief Set the ON/OFF values for all PWM outputs.
*
* @deprecated This API will be deprecated. Please use the new API
* pwm_pin_set_cycles or pwm_pin_set_usec to set the pins
* individually.
*
* @param dev Pointer to the device structure for the driver instance.
* @param on ON value (number of timer count) set to the PWM. HW specific.
* How far from the beginning of a PWM cycle the PWM pulse starts.
* @param off OFF value (number of timer count) set to the PWM. HW specific.
* How far from the beginning of a PWM cycle the PWM pulse stops.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int __deprecated pwm_all_set_values(struct device *dev,
u32_t on, u32_t off)
{
const struct pwm_driver_api *api = dev->driver_api;
return api->set_values(dev, PWM_ACCESS_ALL, 0, on, off);
}
/**
* @brief Set the period of all PWM outputs.
*
* @deprecated This API will be deprecated. Please use the new API
* pwm_pin_set_cycles or pwm_pin_set_usec to set the pins
* individually.
*
* 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 __deprecated pwm_all_period(struct device *dev,
u32_t period)
{
const struct pwm_driver_api *api = dev->driver_api;
return api->set_period(dev, PWM_ACCESS_ALL, 0, period);
}
/**
* @brief Set the duty cycle of all PWM outputs.
*
* @deprecated This API will be deprecated. Please use the new API
* pwm_pin_set_cycles or pwm_pin_set_usec to set the pins
* individually.
*
* 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 __deprecated pwm_all_set_duty_cycle(struct device *dev,
u8_t duty)
{
const struct pwm_driver_api *api = dev->driver_api;
return api->set_duty_cycle(dev, PWM_ACCESS_ALL, 0, duty);
}
/**
* @brief Set the phase of all PWM outputs.
*
* @deprecated This API will be deprecated. Set_phase will not be supported
* any more.
*
* 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 __deprecated pwm_all_set_phase(struct device *dev,
u8_t phase)
{
const struct pwm_driver_api *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__ */
Reference in New Issue View Git Blame Copy Permalink