Zephyr API Documentation 4.3.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Haptics Driver Backend API

Data Structures

struct  haptics_driver_api
  Driver Operations Haptics driver operations More...

Typedefs

typedef int(* haptics_stop_output_t) (const struct device *dev)
 Set the haptic device to stop output.
typedef int(* haptics_start_output_t) (const struct device *dev)
 Set the haptic device to start output for a playback event.
typedef int(* haptics_register_error_callback_t) (const struct device *dev, haptics_error_callback_t cb, void *const user_data)
 Register a callback function for haptics errors.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a Haptics driver.

Typedef Documentation

◆ haptics_register_error_callback_t

typedef int(* haptics_register_error_callback_t) (const struct device *dev, haptics_error_callback_t cb, void *const user_data)

#include <zephyr/drivers/haptics.h>

Register a callback function for haptics errors.

See haptics_register_error_callback() for argument description.

◆ haptics_start_output_t

typedef int(* haptics_start_output_t) (const struct device *dev)

#include <zephyr/drivers/haptics.h>

Set the haptic device to start output for a playback event.

See haptics_start_output() for argument description.

◆ haptics_stop_output_t

typedef int(* haptics_stop_output_t) (const struct device *dev)

#include <zephyr/drivers/haptics.h>

Set the haptic device to stop output.

See haptics_stop_output() for argument description.