summaryrefslogtreecommitdiff
path: root/app/include/drivers/behavior.h
blob: f5f5f53766f8a799bf125e85dbef6d9e3d59fdc0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
 * Copyright (c) 2020 Peter Johanson
 *
 * SPDX-License-Identifier: MIT
 */

#pragma once

#include <zephyr/types.h>
#include <stddef.h>
#include <device.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @cond INTERNAL_HIDDEN
 *
 * Behavior driver API definition and system call entry points.
 *
 * (Internal use only.)
 */

typedef int (*behavior_position_callback_t)(struct device *dev, u32_t param1, u32_t param2);
typedef int (*behavior_keycode_callback_t)(struct device *dev, u32_t keycode);

__subsystem struct behavior_driver_api {
	behavior_position_callback_t position_pressed;
	behavior_position_callback_t position_released;
	behavior_keycode_callback_t keycode_pressed;
	behavior_keycode_callback_t keycode_released;
};
/**
 * @endcond
 */

/**
 * @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_position_pressed(struct device *dev, u32_t param1, u32_t param2);

static inline int z_impl_behavior_position_pressed(struct device *dev, u32_t param1, u32_t param2)
{
	const struct behavior_driver_api *api =
			(const struct behavior_driver_api *)dev->driver_api;

	if (api->position_pressed == NULL) {
		return -ENOTSUP;
	}

	return api->position_pressed(dev, param1, param2);
}

/**
 * @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_position_released(struct device *dev, u32_t param1, u32_t param2);

static inline int z_impl_behavior_position_released(struct device *dev, u32_t param1, u32_t param2)
{
	const struct behavior_driver_api *api =
			(const struct behavior_driver_api *)dev->driver_api;

	if (api->position_released == NULL) {
		return -ENOTSUP;
	}

	return api->position_released(dev, param1, param2);
}

/**
 * @brief Handle the keycode being pressed
 * @param dev Pointer to the device structure for the driver instance.
 * @param keycode The keycode that is being pressed.
 *
 * @retval 0 If successful.
 * @retval Negative errno code if failure.
 */
__syscall int behavior_keycode_pressed(struct device *dev, u32_t keycode);

static inline int z_impl_behavior_keycode_pressed(struct device *dev, u32_t keycode)
{
	const struct behavior_driver_api *api =
			(const struct behavior_driver_api *)dev->driver_api;

	if (api->keycode_pressed == NULL) {
		return -ENOTSUP;
	}

	return api->keycode_pressed(dev, keycode);
}


/**
 * @brief Handle the keycode being released
 * @param dev Pointer to the device structure for the driver instance.
 * @param keycode The keycode that is being pressed.
 *
 * @retval 0 If successful.
 * @retval Negative errno code if failure.
 */
__syscall int behavior_keycode_released(struct device *dev, u32_t keycode);

static inline int z_impl_behavior_keycode_released(struct device *dev, u32_t keycode)
{
	const struct behavior_driver_api *api =
			(const struct behavior_driver_api *)dev->driver_api;

	if (api->keycode_released == NULL) {
		return -ENOTSUP;
	}

	return api->keycode_released(dev, keycode);
}

#ifdef __cplusplus
}
#endif

/**
 * @}
 */

#include <syscalls/behavior.h>