03099b04b6
* For upcoming ZMK studio work, make a set of rich metadata available to provide a friendly name for a behavior, and allow super flexible descriptions of the parameters the behaviors take. * Add ability to validate a zmk_behavior_binding against the behavior metadata available.
38 lines
984 B
C
38 lines
984 B
C
/*
|
|
* Copyright (c) 2020 The ZMK Contributors
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <zephyr/device.h>
|
|
|
|
#define ZMK_BEHAVIOR_OPAQUE 0
|
|
#define ZMK_BEHAVIOR_TRANSPARENT 1
|
|
|
|
struct zmk_behavior_binding {
|
|
const char *behavior_dev;
|
|
uint32_t param1;
|
|
uint32_t param2;
|
|
};
|
|
|
|
struct zmk_behavior_binding_event {
|
|
int layer;
|
|
uint32_t position;
|
|
int64_t timestamp;
|
|
};
|
|
|
|
/**
|
|
* @brief Get a const struct device* for a behavior from its @p name field.
|
|
*
|
|
* @param name Behavior name to search for.
|
|
*
|
|
* @retval Pointer to the device structure for the behavior with the given name.
|
|
* @retval NULL if the behavior is not found or its initialization function failed.
|
|
*
|
|
* @note This is equivalent to device_get_binding(), except it only searches
|
|
* behavior devices, so it is faster and there is no chance of it returning an
|
|
* unrelated node which shares the same name as a behavior.
|
|
*/
|
|
const struct device *zmk_behavior_get_binding(const char *name);
|