/* * Copyright (c) 2020 The ZMK Contributors * * SPDX-License-Identifier: MIT */ #pragma once #include #include #include #include #include /** * @cond INTERNAL_HIDDEN * * Behavior driver API definition and system call entry points. * * (Internal use only.) */ typedef int (*behavior_keymap_binding_callback_t)(struct zmk_behavior_binding *binding, struct zmk_behavior_binding_event event); typedef int (*behavior_sensor_keymap_binding_callback_t)(struct zmk_behavior_binding *binding, struct device *sensor); __subsystem struct behavior_driver_api { behavior_keymap_binding_callback_t binding_pressed; behavior_keymap_binding_callback_t binding_released; behavior_sensor_keymap_binding_callback_t sensor_binding_triggered; }; /** * @endcond */ /** * @brief Handle the keymap binding being pressed * @param dev Pointer to the device structure for the driver instance. * @param param1 User parameter specified at time of behavior binding. * @param param2 User parameter specified at time of behavior binding. * * @retval 0 If successful. * @retval Negative errno code if failure. */ __syscall int behavior_keymap_binding_pressed(struct zmk_behavior_binding *binding, struct zmk_behavior_binding_event event); static inline int z_impl_behavior_keymap_binding_pressed(struct zmk_behavior_binding *binding, struct zmk_behavior_binding_event event) { struct device *dev = device_get_binding(binding->behavior_dev); const struct behavior_driver_api *api = (const struct behavior_driver_api *)dev->driver_api; if (api->binding_pressed == NULL) { return -ENOTSUP; } return api->binding_pressed(binding, event); } /** * @brief Handle the assigned position being pressed * @param dev Pointer to the device structure for the driver instance. * @param param1 User parameter specified at time of behavior assignment. * * @retval 0 If successful. * @retval Negative errno code if failure. */ __syscall int behavior_keymap_binding_released(struct zmk_behavior_binding *binding, struct zmk_behavior_binding_event event); static inline int z_impl_behavior_keymap_binding_released(struct zmk_behavior_binding *binding, struct zmk_behavior_binding_event event) { struct device *dev = device_get_binding(binding->behavior_dev); const struct behavior_driver_api *api = (const struct behavior_driver_api *)dev->driver_api; if (api->binding_released == NULL) { return -ENOTSUP; } return api->binding_released(binding, event); } /** * @brief Handle the a sensor keymap binding being triggered * @param dev Pointer to the device structure for the driver instance. * @param sensor Pointer to the sensor device structure for the sensor driver instance. * @param param1 User parameter specified at time of behavior binding. * @param param2 User parameter specified at time of behavior binding. * * @retval 0 If successful. * @retval Negative errno code if failure. */ __syscall int behavior_sensor_keymap_binding_triggered(struct zmk_behavior_binding *binding, struct device *sensor); static inline int z_impl_behavior_sensor_keymap_binding_triggered(struct zmk_behavior_binding *binding, struct device *sensor) { struct device *dev = device_get_binding(binding->behavior_dev); const struct behavior_driver_api *api = (const struct behavior_driver_api *)dev->driver_api; if (api->sensor_binding_triggered == NULL) { return -ENOTSUP; } return api->sensor_binding_triggered(binding, sensor); } /** * @} */ #include