haptics.h

Go to the documentation of this file.

/*
 * Copyright 2024 Cirrus Logic, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_HAPTICS_H_
#define ZEPHYR_INCLUDE_DRIVERS_HAPTICS_H_

 
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif

enum haptics_error_type {
        HAPTICS_ERROR_OVERCURRENT = BIT(0),     
        HAPTICS_ERROR_OVERTEMPERATURE = BIT(1), 
        HAPTICS_ERROR_UNDERVOLTAGE = BIT(2),    
        HAPTICS_ERROR_OVERVOLTAGE = BIT(3),     
        HAPTICS_ERROR_DC = BIT(4),              
 
        /* Device-specific error codes can follow, refer to the device’s header file */
        HAPTICS_ERROR_PRIV_START = BIT(5),
};

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

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

typedef void (*haptics_error_callback_t)(const struct device *dev, const uint32_t errors,
                                         void *const user_data);

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

__subsystem struct haptics_driver_api {
        haptics_start_output_t start_output;
        haptics_stop_output_t stop_output;
        haptics_register_error_callback_t register_error_callback;
};

__syscall int haptics_start_output(const struct device *dev);
 
static inline int z_impl_haptics_start_output(const struct device *dev)
{
        const struct haptics_driver_api *api = (const struct haptics_driver_api *)dev->api;
 
        return api->start_output(dev);
}

__syscall int haptics_stop_output(const struct device *dev);
 
static inline int z_impl_haptics_stop_output(const struct device *dev)
{
        const struct haptics_driver_api *api = (const struct haptics_driver_api *)dev->api;
 
        return api->stop_output(dev);
}

static inline int haptics_register_error_callback(const struct device *dev,
                                                  haptics_error_callback_t cb,
                                                  void *const user_data)
{
        const struct haptics_driver_api *api = (const struct haptics_driver_api *)dev->api;
 
        if (api->register_error_callback == NULL) {
                return -ENOSYS;
        }
 
        return api->register_error_callback(dev, cb, user_data);
}

 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#include <syscalls/haptics.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_HAPTICS_H_ */