Zephyr Project API 4.4.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
pwm_driver_api Struct Reference

@driver_ops{PWM} More...

#include <pwm.h>

Data Fields

pwm_set_cycles_t set_cycles
 @driver_ops_mandatory Set the period and pulse width for a single PWM output.
pwm_get_cycles_per_sec_t get_cycles_per_sec
 @driver_ops_mandatory Get the clock rate (cycles per second) for a single PWM output.
pwm_configure_capture_t configure_capture
 @driver_ops_optional Configure PWM period/pulse width capture for a single PWM input.
pwm_enable_capture_t enable_capture
 @driver_ops_optional Enable PWM period/pulse width capture for a single PWM input.
pwm_disable_capture_t disable_capture
 @driver_ops_optional Disable PWM period/pulse width capture for a single PWM input.
pwm_manage_event_callback_t manage_event_callback
 @driver_ops_optional Add an application event callback.

Detailed Description

@driver_ops{PWM}

Field Documentation

◆ configure_capture

pwm_configure_capture_t pwm_driver_api::configure_capture

@driver_ops_optional Configure PWM period/pulse width capture for a single PWM input.

Attention
Available only when the following Kconfig option is enabled:
CONFIG_PWM_CAPTURE 
.

◆ disable_capture

pwm_disable_capture_t pwm_driver_api::disable_capture

@driver_ops_optional Disable PWM period/pulse width capture for a single PWM input.

Attention
Available only when the following Kconfig option is enabled:
CONFIG_PWM_CAPTURE 
.

◆ enable_capture

pwm_enable_capture_t pwm_driver_api::enable_capture

@driver_ops_optional Enable PWM period/pulse width capture for a single PWM input.

Attention
Available only when the following Kconfig option is enabled:
CONFIG_PWM_CAPTURE 
.

◆ get_cycles_per_sec

pwm_get_cycles_per_sec_t pwm_driver_api::get_cycles_per_sec

@driver_ops_mandatory Get the clock rate (cycles per second) for a single PWM output.

◆ manage_event_callback

pwm_manage_event_callback_t pwm_driver_api::manage_event_callback

@driver_ops_optional Add an application event callback.

Attention
Available only when the following Kconfig option is enabled:
CONFIG_PWM_EVENT 
.

◆ set_cycles

pwm_set_cycles_t pwm_driver_api::set_cycles

@driver_ops_mandatory Set the period and pulse width for a single PWM output.


The documentation for this struct was generated from the following file:
  • include/zephyr/drivers/pwm.h