/* * Copyright (c) 2016 Intel Corporation. * Copyright (c) 2020-2021 Vestas Wind Systems A/S * * SPDX-License-Identifier: Apache-2.0 */ /** * @file * @brief Public PWM Driver APIs */ #ifndef ZEPHYR_INCLUDE_DRIVERS_PWM_H_ #define ZEPHYR_INCLUDE_DRIVERS_PWM_H_ /** * @brief PWM Interface * @defgroup pwm_interface PWM Interface * @since 1.0 * @version 1.0.0 * @ingroup io_interfaces * @{ */ #include #include #include #include #include #include #include #include #ifdef __cplusplus extern "C" { #endif /** * @name PWM capture configuration flags * @anchor PWM_CAPTURE_FLAGS * @{ */ /** @cond INTERNAL_HIDDEN */ /* Bit 0 is used for PWM_POLARITY_NORMAL/PWM_POLARITY_INVERTED */ #define PWM_CAPTURE_TYPE_SHIFT 1U #define PWM_CAPTURE_TYPE_MASK (3U << PWM_CAPTURE_TYPE_SHIFT) #define PWM_CAPTURE_MODE_SHIFT 3U #define PWM_CAPTURE_MODE_MASK (1U << PWM_CAPTURE_MODE_SHIFT) /** @endcond */ /** PWM pin capture captures period. */ #define PWM_CAPTURE_TYPE_PERIOD (1U << PWM_CAPTURE_TYPE_SHIFT) /** PWM pin capture captures pulse width. */ #define PWM_CAPTURE_TYPE_PULSE (2U << PWM_CAPTURE_TYPE_SHIFT) /** PWM pin capture captures both period and pulse width. */ #define PWM_CAPTURE_TYPE_BOTH (PWM_CAPTURE_TYPE_PERIOD | \ PWM_CAPTURE_TYPE_PULSE) /** PWM pin capture captures a single period/pulse width. */ #define PWM_CAPTURE_MODE_SINGLE (0U << PWM_CAPTURE_MODE_SHIFT) /** PWM pin capture captures period/pulse width continuously. */ #define PWM_CAPTURE_MODE_CONTINUOUS (1U << PWM_CAPTURE_MODE_SHIFT) /** @} */ /** * @brief Provides a type to hold PWM configuration flags. * * The lower 8 bits are used for standard flags. * The upper 8 bits are reserved for SoC specific flags. * * @see @ref PWM_CAPTURE_FLAGS. */ typedef uint16_t pwm_flags_t; /** * @brief Container for PWM information specified in devicetree. * * This type contains a pointer to a PWM device, channel number (controlled by * the PWM device), the PWM signal period in nanoseconds and the flags * applicable to the channel. Note that not all PWM drivers support flags. In * such case, flags will be set to 0. * * @see PWM_DT_SPEC_GET_BY_NAME * @see PWM_DT_SPEC_GET_BY_NAME_OR * @see PWM_DT_SPEC_GET_BY_IDX * @see PWM_DT_SPEC_GET_BY_IDX_OR * @see PWM_DT_SPEC_GET * @see PWM_DT_SPEC_GET_OR */ struct pwm_dt_spec { /** PWM device instance. */ const struct device *dev; /** Channel number. */ uint32_t channel; /** Period in nanoseconds. */ uint32_t period; /** Flags. */ pwm_flags_t flags; }; /** * @brief Static initializer for a struct pwm_dt_spec * * This returns a static initializer for a struct pwm_dt_spec given a devicetree * node identifier and an index. * * Example devicetree fragment: * * @code{.dts} * n: node { * pwms = <&pwm1 1 1000 PWM_POLARITY_NORMAL>, * <&pwm2 3 2000 PWM_POLARITY_INVERTED>; * pwm-names = "alpha", "beta"; * }; * @endcode * * Example usage: * * @code{.c} * const struct pwm_dt_spec spec = * PWM_DT_SPEC_GET_BY_NAME(DT_NODELABEL(n), alpha); * * // Initializes 'spec' to: * // { * // .dev = DEVICE_DT_GET(DT_NODELABEL(pwm1)), * // .channel = 1, * // .period = 1000, * // .flags = PWM_POLARITY_NORMAL, * // } * @endcode * * The device (dev) must still be checked for readiness, e.g. using * device_is_ready(). It is an error to use this macro unless the node exists, * has the 'pwms' property, and that 'pwms' property specifies a PWM controller, * a channel, a period in nanoseconds and optionally flags. * * @param node_id Devicetree node identifier. * @param name Lowercase-and-underscores name of a pwms element as defined by * the node's pwm-names property. * * @return Static initializer for a struct pwm_dt_spec for the property. * * @see PWM_DT_SPEC_INST_GET_BY_NAME */ #define PWM_DT_SPEC_GET_BY_NAME(node_id, name) \ { \ .dev = DEVICE_DT_GET(DT_PWMS_CTLR_BY_NAME(node_id, name)), \ .channel = DT_PWMS_CHANNEL_BY_NAME(node_id, name), \ .period = DT_PWMS_PERIOD_BY_NAME(node_id, name), \ .flags = DT_PWMS_FLAGS_BY_NAME(node_id, name), \ } /** * @brief Static initializer for a struct pwm_dt_spec from a DT_DRV_COMPAT * instance. * * @param inst DT_DRV_COMPAT instance number * @param name Lowercase-and-underscores name of a pwms element as defined by * the node's pwm-names property. * * @return Static initializer for a struct pwm_dt_spec for the property. * * @see PWM_DT_SPEC_GET_BY_NAME */ #define PWM_DT_SPEC_INST_GET_BY_NAME(inst, name) \ PWM_DT_SPEC_GET_BY_NAME(DT_DRV_INST(inst), name) /** * @brief Like PWM_DT_SPEC_GET_BY_NAME(), with a fallback to a default value. * * If the devicetree node identifier 'node_id' refers to a node with a property * 'pwms', this expands to PWM_DT_SPEC_GET_BY_NAME(node_id, name). The * @p default_value parameter is not expanded in this case. Otherwise, this * expands to @p default_value. * * @param node_id Devicetree node identifier. * @param name Lowercase-and-underscores name of a pwms element as defined by * the node's pwm-names property * @param default_value Fallback value to expand to. * * @return Static initializer for a struct pwm_dt_spec for the property, * or @p default_value if the node or property do not exist. * * @see PWM_DT_SPEC_INST_GET_BY_NAME_OR */ #define PWM_DT_SPEC_GET_BY_NAME_OR(node_id, name, default_value) \ COND_CODE_1(DT_NODE_HAS_PROP(node_id, pwms), \ (PWM_DT_SPEC_GET_BY_NAME(node_id, name)), \ (default_value)) /** * @brief Like PWM_DT_SPEC_INST_GET_BY_NAME(), with a fallback to a default * value. * * @param inst DT_DRV_COMPAT instance number * @param name Lowercase-and-underscores name of a pwms element as defined by * the node's pwm-names property. * @param default_value Fallback value to expand to. * * @return Static initializer for a struct pwm_dt_spec for the property, * or @p default_value if the node or property do not exist. * * @see PWM_DT_SPEC_GET_BY_NAME_OR */ #define PWM_DT_SPEC_INST_GET_BY_NAME_OR(inst, name, default_value) \ PWM_DT_SPEC_GET_BY_NAME_OR(DT_DRV_INST(inst), name, default_value) /** * @brief Static initializer for a struct pwm_dt_spec * * This returns a static initializer for a struct pwm_dt_spec given a devicetree * node identifier and an index. * * Example devicetree fragment: * * @code{.dts} * n: node { * pwms = <&pwm1 1 1000 PWM_POLARITY_NORMAL>, * <&pwm2 3 2000 PWM_POLARITY_INVERTED>; * }; * @endcode * * Example usage: * * @code{.c} * const struct pwm_dt_spec spec = * PWM_DT_SPEC_GET_BY_IDX(DT_NODELABEL(n), 1); * * // Initializes 'spec' to: * // { * // .dev = DEVICE_DT_GET(DT_NODELABEL(pwm2)), * // .channel = 3, * // .period = 2000, * // .flags = PWM_POLARITY_INVERTED, * // } * @endcode * * The device (dev) must still be checked for readiness, e.g. using * device_is_ready(). It is an error to use this macro unless the node exists, * has the 'pwms' property, and that 'pwms' property specifies a PWM controller, * a channel, a period in nanoseconds and optionally flags. * * @param node_id Devicetree node identifier. * @param idx Logical index into 'pwms' property. * * @return Static initializer for a struct pwm_dt_spec for the property. * * @see PWM_DT_SPEC_INST_GET_BY_IDX */ #define PWM_DT_SPEC_GET_BY_IDX(node_id, idx) \ { \ .dev = DEVICE_DT_GET(DT_PWMS_CTLR_BY_IDX(node_id, idx)), \ .channel = DT_PWMS_CHANNEL_BY_IDX(node_id, idx), \ .period = DT_PWMS_PERIOD_BY_IDX(node_id, idx), \ .flags = DT_PWMS_FLAGS_BY_IDX(node_id, idx), \ } /** * @brief Static initializer for a struct pwm_dt_spec from a DT_DRV_COMPAT * instance. * * @param inst DT_DRV_COMPAT instance number * @param idx Logical index into 'pwms' property. * * @return Static initializer for a struct pwm_dt_spec for the property. * * @see PWM_DT_SPEC_GET_BY_IDX */ #define PWM_DT_SPEC_INST_GET_BY_IDX(inst, idx) \ PWM_DT_SPEC_GET_BY_IDX(DT_DRV_INST(inst), idx) /** * @brief Like PWM_DT_SPEC_GET_BY_IDX(), with a fallback to a default value. * * If the devicetree node identifier 'node_id' refers to a node with a property * 'pwms', this expands to PWM_DT_SPEC_GET_BY_IDX(node_id, idx). The * @p default_value parameter is not expanded in this case. Otherwise, this * expands to @p default_value. * * @param node_id Devicetree node identifier. * @param idx Logical index into 'pwms' property. * @param default_value Fallback value to expand to. * * @return Static initializer for a struct pwm_dt_spec for the property, * or @p default_value if the node or property do not exist. * * @see PWM_DT_SPEC_INST_GET_BY_IDX_OR */ #define PWM_DT_SPEC_GET_BY_IDX_OR(node_id, idx, default_value) \ COND_CODE_1(DT_NODE_HAS_PROP(node_id, pwms), \ (PWM_DT_SPEC_GET_BY_IDX(node_id, idx)), \ (default_value)) /** * @brief Like PWM_DT_SPEC_INST_GET_BY_IDX(), with a fallback to a default * value. * * @param inst DT_DRV_COMPAT instance number * @param idx Logical index into 'pwms' property. * @param default_value Fallback value to expand to. * * @return Static initializer for a struct pwm_dt_spec for the property, * or @p default_value if the node or property do not exist. * * @see PWM_DT_SPEC_GET_BY_IDX_OR */ #define PWM_DT_SPEC_INST_GET_BY_IDX_OR(inst, idx, default_value) \ PWM_DT_SPEC_GET_BY_IDX_OR(DT_DRV_INST(inst), idx, default_value) /** * @brief Equivalent to PWM_DT_SPEC_GET_BY_IDX(node_id, 0). * * @param node_id Devicetree node identifier. * * @return Static initializer for a struct pwm_dt_spec for the property. * * @see PWM_DT_SPEC_GET_BY_IDX * @see PWM_DT_SPEC_INST_GET */ #define PWM_DT_SPEC_GET(node_id) PWM_DT_SPEC_GET_BY_IDX(node_id, 0) /** * @brief Equivalent to PWM_DT_SPEC_INST_GET_BY_IDX(inst, 0). * * @param inst DT_DRV_COMPAT instance number * * @return Static initializer for a struct pwm_dt_spec for the property. * * @see PWM_DT_SPEC_INST_GET_BY_IDX * @see PWM_DT_SPEC_GET */ #define PWM_DT_SPEC_INST_GET(inst) PWM_DT_SPEC_GET(DT_DRV_INST(inst)) /** * @brief Equivalent to * PWM_DT_SPEC_GET_BY_IDX_OR(node_id, 0, default_value). * * @param node_id Devicetree node identifier. * @param default_value Fallback value to expand to. * * @return Static initializer for a struct pwm_dt_spec for the property. * * @see PWM_DT_SPEC_GET_BY_IDX_OR * @see PWM_DT_SPEC_INST_GET_OR */ #define PWM_DT_SPEC_GET_OR(node_id, default_value) \ PWM_DT_SPEC_GET_BY_IDX_OR(node_id, 0, default_value) /** * @brief Equivalent to * PWM_DT_SPEC_INST_GET_BY_IDX_OR(inst, 0, default_value). * * @param inst DT_DRV_COMPAT instance number * @param default_value Fallback value to expand to. * * @return Static initializer for a struct pwm_dt_spec for the property. * * @see PWM_DT_SPEC_INST_GET_BY_IDX_OR * @see PWM_DT_SPEC_GET_OR */ #define PWM_DT_SPEC_INST_GET_OR(inst, default_value) \ PWM_DT_SPEC_GET_OR(DT_DRV_INST(inst), default_value) /** * @brief PWM capture callback handler function signature * * @note The callback handler will be called in interrupt context. * * @note @kconfig{CONFIG_PWM_CAPTURE} must be selected to enable PWM capture * support. * * @param[in] dev PWM device instance. * @param channel PWM channel. * @param period_cycles Captured PWM period width (in clock cycles). HW * specific. * @param pulse_cycles Captured PWM pulse width (in clock cycles). HW specific. * @param status Status for the PWM capture (0 if no error, negative errno * otherwise. See pwm_capture_cycles() return value * descriptions for details). * @param user_data User data passed to pwm_configure_capture() */ typedef void (*pwm_capture_callback_handler_t)(const struct device *dev, uint32_t channel, uint32_t period_cycles, uint32_t pulse_cycles, int status, void *user_data); /** @cond INTERNAL_HIDDEN */ /** * @brief PWM driver API call to configure PWM pin period and pulse width. * @see pwm_set_cycles() for argument description. */ typedef int (*pwm_set_cycles_t)(const struct device *dev, uint32_t channel, uint32_t period_cycles, uint32_t pulse_cycles, pwm_flags_t flags); /** * @brief PWM driver API call to obtain the PWM cycles per second (frequency). * @see pwm_get_cycles_per_sec() for argument description */ typedef int (*pwm_get_cycles_per_sec_t)(const struct device *dev, uint32_t channel, uint64_t *cycles); #ifdef CONFIG_PWM_CAPTURE /** * @brief PWM driver API call to configure PWM capture. * @see pwm_configure_capture() for argument description. */ typedef int (*pwm_configure_capture_t)(const struct device *dev, uint32_t channel, pwm_flags_t flags, pwm_capture_callback_handler_t cb, void *user_data); /** * @brief PWM driver API call to enable PWM capture. * @see pwm_enable_capture() for argument description. */ typedef int (*pwm_enable_capture_t)(const struct device *dev, uint32_t channel); /** * @brief PWM driver API call to disable PWM capture. * @see pwm_disable_capture() for argument description */ typedef int (*pwm_disable_capture_t)(const struct device *dev, uint32_t channel); #endif /* CONFIG_PWM_CAPTURE */ /** @brief PWM driver API definition. */ __subsystem struct pwm_driver_api { pwm_set_cycles_t set_cycles; pwm_get_cycles_per_sec_t get_cycles_per_sec; #ifdef CONFIG_PWM_CAPTURE pwm_configure_capture_t configure_capture; pwm_enable_capture_t enable_capture; pwm_disable_capture_t disable_capture; #endif /* CONFIG_PWM_CAPTURE */ }; /** @endcond */ /** * @brief Set the period and pulse width for a single PWM output. * * The PWM period and pulse width will synchronously be set to the new values * without glitches in the PWM signal, but the call will not block for the * change to take effect. * * @note Not all PWM controllers support synchronous, glitch-free updates of the * PWM period and pulse width. Depending on the hardware, changing the PWM * period and/or pulse width may cause a glitch in the generated PWM signal. * * @note Some multi-channel PWM controllers share the PWM period across all * channels. Depending on the hardware, changing the PWM period for one channel * may affect the PWM period for the other channels of the same PWM controller. * * Passing 0 as @p pulse will cause the pin to be driven to a constant * inactive level. * Passing a non-zero @p pulse equal to @p period will cause the pin * to be driven to a constant active level. * * @param[in] dev PWM device instance. * @param channel PWM channel. * @param period Period (in clock cycles) set to the PWM. HW specific. * @param pulse Pulse width (in clock cycles) set to the PWM. HW specific. * @param flags Flags for pin configuration. * * @retval 0 If successful. * @retval -EINVAL If pulse > period. * @retval -errno Negative errno code on failure. */ __syscall int pwm_set_cycles(const struct device *dev, uint32_t channel, uint32_t period, uint32_t pulse, pwm_flags_t flags); static inline int z_impl_pwm_set_cycles(const struct device *dev, uint32_t channel, uint32_t period, uint32_t pulse, pwm_flags_t flags) { const struct pwm_driver_api *api = (const struct pwm_driver_api *)dev->api; if (pulse > period) { return -EINVAL; } return api->set_cycles(dev, channel, period, pulse, flags); } /** * @brief Get the clock rate (cycles per second) for a single PWM output. * * @param[in] dev PWM device instance. * @param channel PWM channel. * @param[out] cycles Pointer to the memory to store clock rate (cycles per * sec). HW specific. * * @retval 0 If successful. * @retval -errno Negative errno code on failure. */ __syscall int pwm_get_cycles_per_sec(const struct device *dev, uint32_t channel, uint64_t *cycles); static inline int z_impl_pwm_get_cycles_per_sec(const struct device *dev, uint32_t channel, uint64_t *cycles) { const struct pwm_driver_api *api = (const struct pwm_driver_api *)dev->api; return api->get_cycles_per_sec(dev, channel, cycles); } /** * @brief Set the period and pulse width in nanoseconds for a single PWM output. * * @note Utility macros such as PWM_MSEC() can be used to convert from other * scales or units to nanoseconds, the units used by this function. * * @param[in] dev PWM device instance. * @param channel PWM channel. * @param period Period (in nanoseconds) set to the PWM. * @param pulse Pulse width (in nanoseconds) set to the PWM. * @param flags Flags for pin configuration (polarity). * * @retval 0 If successful. * @retval -ENOTSUP If requested period or pulse cycles are not supported. * @retval -errno Other negative errno code on failure. */ static inline int pwm_set(const struct device *dev, uint32_t channel, uint32_t period, uint32_t pulse, pwm_flags_t flags) { int err; uint64_t pulse_cycles; uint64_t period_cycles; uint64_t cycles_per_sec; err = pwm_get_cycles_per_sec(dev, channel, &cycles_per_sec); if (err < 0) { return err; } period_cycles = (period * cycles_per_sec) / NSEC_PER_SEC; if (period_cycles > UINT32_MAX) { return -ENOTSUP; } pulse_cycles = (pulse * cycles_per_sec) / NSEC_PER_SEC; if (pulse_cycles > UINT32_MAX) { return -ENOTSUP; } return pwm_set_cycles(dev, channel, (uint32_t)period_cycles, (uint32_t)pulse_cycles, flags); } /** * @brief Set the period and pulse width in nanoseconds from a struct * pwm_dt_spec (with custom period). * * This is equivalent to: * * pwm_set(spec->dev, spec->channel, period, pulse, spec->flags) * * The period specified in @p spec is ignored. This API call can be used when * the period specified in Devicetree needs to be changed at runtime. * * @param[in] spec PWM specification from devicetree. * @param period Period (in nanoseconds) set to the PWM. * @param pulse Pulse width (in nanoseconds) set to the PWM. * * @return A value from pwm_set(). * * @see pwm_set_pulse_dt() */ static inline int pwm_set_dt(const struct pwm_dt_spec *spec, uint32_t period, uint32_t pulse) { return pwm_set(spec->dev, spec->channel, period, pulse, spec->flags); } /** * @brief Set the period and pulse width in nanoseconds from a struct * pwm_dt_spec. * * This is equivalent to: * * pwm_set(spec->dev, spec->channel, spec->period, pulse, spec->flags) * * @param[in] spec PWM specification from devicetree. * @param pulse Pulse width (in nanoseconds) set to the PWM. * * @return A value from pwm_set(). * * @see pwm_set_pulse_dt() */ static inline int pwm_set_pulse_dt(const struct pwm_dt_spec *spec, uint32_t pulse) { return pwm_set(spec->dev, spec->channel, spec->period, pulse, spec->flags); } /** * @brief Convert from PWM cycles to microseconds. * * @param[in] dev PWM device instance. * @param channel PWM channel. * @param cycles Cycles to be converted. * @param[out] usec Pointer to the memory to store calculated usec. * * @retval 0 If successful. * @retval -ERANGE If result is too large. * @retval -errno Other negative errno code on failure. */ static inline int pwm_cycles_to_usec(const struct device *dev, uint32_t channel, uint32_t cycles, uint64_t *usec) { int err; uint64_t temp; uint64_t cycles_per_sec; err = pwm_get_cycles_per_sec(dev, channel, &cycles_per_sec); if (err < 0) { return err; } if (u64_mul_overflow(cycles, (uint64_t)USEC_PER_SEC, &temp)) { return -ERANGE; } *usec = temp / cycles_per_sec; return 0; } /** * @brief Convert from PWM cycles to nanoseconds. * * @param[in] dev PWM device instance. * @param channel PWM channel. * @param cycles Cycles to be converted. * @param[out] nsec Pointer to the memory to store the calculated nsec. * * @retval 0 If successful. * @retval -ERANGE If result is too large. * @retval -errno Other negative errno code on failure. */ static inline int pwm_cycles_to_nsec(const struct device *dev, uint32_t channel, uint32_t cycles, uint64_t *nsec) { int err; uint64_t temp; uint64_t cycles_per_sec; err = pwm_get_cycles_per_sec(dev, channel, &cycles_per_sec); if (err < 0) { return err; } if (u64_mul_overflow(cycles, (uint64_t)NSEC_PER_SEC, &temp)) { return -ERANGE; } *nsec = temp / cycles_per_sec; return 0; } #if defined(CONFIG_PWM_CAPTURE) || defined(__DOXYGEN__) /** * @brief Configure PWM period/pulse width capture for a single PWM input. * * After configuring PWM capture using this function, the capture can be * enabled/disabled using pwm_enable_capture() and * pwm_disable_capture(). * * @note This API function cannot be invoked from user space due to the use of a * function callback. In user space, one of the simpler API functions * (pwm_capture_cycles(), pwm_capture_usec(), or * pwm_capture_nsec()) can be used instead. * * @note @kconfig{CONFIG_PWM_CAPTURE} must be selected for this function to be * available. * * @param[in] dev PWM device instance. * @param channel PWM channel. * @param flags PWM capture flags * @param[in] cb Application callback handler function to be called upon capture * @param[in] user_data User data to pass to the application callback handler * function * * @retval -EINVAL if invalid function parameters were given * @retval -ENOSYS if PWM capture is not supported or the given flags are not * supported * @retval -EIO if IO error occurred while configuring * @retval -EBUSY if PWM capture is already in progress */ static inline int pwm_configure_capture(const struct device *dev, uint32_t channel, pwm_flags_t flags, pwm_capture_callback_handler_t cb, void *user_data) { const struct pwm_driver_api *api = (const struct pwm_driver_api *)dev->api; if (api->configure_capture == NULL) { return -ENOSYS; } return api->configure_capture(dev, channel, flags, cb, user_data); } #endif /* CONFIG_PWM_CAPTURE */ /** * @brief Enable PWM period/pulse width capture for a single PWM input. * * The PWM pin must be configured using pwm_configure_capture() prior to * calling this function. * * @note @kconfig{CONFIG_PWM_CAPTURE} must be selected for this function to be * available. * * @param[in] dev PWM device instance. * @param channel PWM channel. * * @retval 0 If successful. * @retval -EINVAL if invalid function parameters were given * @retval -ENOSYS if PWM capture is not supported * @retval -EIO if IO error occurred while enabling PWM capture * @retval -EBUSY if PWM capture is already in progress */ __syscall int pwm_enable_capture(const struct device *dev, uint32_t channel); #ifdef CONFIG_PWM_CAPTURE static inline int z_impl_pwm_enable_capture(const struct device *dev, uint32_t channel) { const struct pwm_driver_api *api = (const struct pwm_driver_api *)dev->api; if (api->enable_capture == NULL) { return -ENOSYS; } return api->enable_capture(dev, channel); } #endif /* CONFIG_PWM_CAPTURE */ /** * @brief Disable PWM period/pulse width capture for a single PWM input. * * @note @kconfig{CONFIG_PWM_CAPTURE} must be selected for this function to be * available. * * @param[in] dev PWM device instance. * @param channel PWM channel. * * @retval 0 If successful. * @retval -EINVAL if invalid function parameters were given * @retval -ENOSYS if PWM capture is not supported * @retval -EIO if IO error occurred while disabling PWM capture */ __syscall int pwm_disable_capture(const struct device *dev, uint32_t channel); #ifdef CONFIG_PWM_CAPTURE static inline int z_impl_pwm_disable_capture(const struct device *dev, uint32_t channel) { const struct pwm_driver_api *api = (const struct pwm_driver_api *)dev->api; if (api->disable_capture == NULL) { return -ENOSYS; } return api->disable_capture(dev, channel); } #endif /* CONFIG_PWM_CAPTURE */ /** * @brief Capture a single PWM period/pulse width in clock cycles for a single * PWM input. * * This API function wraps calls to pwm_configure_capture(), * pwm_enable_capture(), and pwm_disable_capture() and passes * the capture result to the caller. The function is blocking until either the * PWM capture is completed or a timeout occurs. * * @note @kconfig{CONFIG_PWM_CAPTURE} must be selected for this function to be * available. * * @param[in] dev PWM device instance. * @param channel PWM channel. * @param flags PWM capture flags. * @param[out] period Pointer to the memory to store the captured PWM period * width (in clock cycles). HW specific. * @param[out] pulse Pointer to the memory to store the captured PWM pulse width * (in clock cycles). HW specific. * @param timeout Waiting period for the capture to complete. * * @retval 0 If successful. * @retval -EBUSY PWM capture already in progress. * @retval -EAGAIN Waiting period timed out. * @retval -EIO IO error while capturing. * @retval -ERANGE If result is too large. */ __syscall int pwm_capture_cycles(const struct device *dev, uint32_t channel, pwm_flags_t flags, uint32_t *period, uint32_t *pulse, k_timeout_t timeout); /** * @brief Capture a single PWM period/pulse width in microseconds for a single * PWM input. * * This API function wraps calls to pwm_capture_cycles() and * pwm_cycles_to_usec() and passes the capture result to the caller. The * function is blocking until either the PWM capture is completed or a timeout * occurs. * * @note @kconfig{CONFIG_PWM_CAPTURE} must be selected for this function to be * available. * * @param[in] dev PWM device instance. * @param channel PWM channel. * @param flags PWM capture flags. * @param[out] period Pointer to the memory to store the captured PWM period * width (in usec). * @param[out] pulse Pointer to the memory to store the captured PWM pulse width * (in usec). * @param timeout Waiting period for the capture to complete. * * @retval 0 If successful. * @retval -EBUSY PWM capture already in progress. * @retval -EAGAIN Waiting period timed out. * @retval -EIO IO error while capturing. * @retval -ERANGE If result is too large. * @retval -errno Other negative errno code on failure. */ static inline int pwm_capture_usec(const struct device *dev, uint32_t channel, pwm_flags_t flags, uint64_t *period, uint64_t *pulse, k_timeout_t timeout) { int err; uint32_t pulse_cycles; uint32_t period_cycles; err = pwm_capture_cycles(dev, channel, flags, &period_cycles, &pulse_cycles, timeout); if (err < 0) { return err; } err = pwm_cycles_to_usec(dev, channel, period_cycles, period); if (err < 0) { return err; } err = pwm_cycles_to_usec(dev, channel, pulse_cycles, pulse); if (err < 0) { return err; } return 0; } /** * @brief Capture a single PWM period/pulse width in nanoseconds for a single * PWM input. * * This API function wraps calls to pwm_capture_cycles() and * pwm_cycles_to_nsec() and passes the capture result to the caller. The * function is blocking until either the PWM capture is completed or a timeout * occurs. * * @note @kconfig{CONFIG_PWM_CAPTURE} must be selected for this function to be * available. * * @param[in] dev PWM device instance. * @param channel PWM channel. * @param flags PWM capture flags. * @param[out] period Pointer to the memory to store the captured PWM period * width (in nsec). * @param[out] pulse Pointer to the memory to store the captured PWM pulse width * (in nsec). * @param timeout Waiting period for the capture to complete. * * @retval 0 If successful. * @retval -EBUSY PWM capture already in progress. * @retval -EAGAIN Waiting period timed out. * @retval -EIO IO error while capturing. * @retval -ERANGE If result is too large. * @retval -errno Other negative errno code on failure. */ static inline int pwm_capture_nsec(const struct device *dev, uint32_t channel, pwm_flags_t flags, uint64_t *period, uint64_t *pulse, k_timeout_t timeout) { int err; uint32_t pulse_cycles; uint32_t period_cycles; err = pwm_capture_cycles(dev, channel, flags, &period_cycles, &pulse_cycles, timeout); if (err < 0) { return err; } err = pwm_cycles_to_nsec(dev, channel, period_cycles, period); if (err < 0) { return err; } err = pwm_cycles_to_nsec(dev, channel, pulse_cycles, pulse); if (err < 0) { return err; } return 0; } /** * @brief Validate that the PWM device is ready. * * @param spec PWM specification from devicetree * * @retval true If the PWM device is ready for use * @retval false If the PWM device is not ready for use */ static inline bool pwm_is_ready_dt(const struct pwm_dt_spec *spec) { return device_is_ready(spec->dev); } #ifdef __cplusplus } #endif /** * @} */ #include #endif /* ZEPHYR_INCLUDE_DRIVERS_PWM_H_ */