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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/* Copyright 2022 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/**
* @file
* @brief Chrome OS-specific API for raw keyboard access
* This exists only support the interface expected by the Chrome OS EC. It seems
* better to implement this so we can make use of most of the existing code in
* its keyboard_scan.c file and thus make sure we operate the same way.
*
* It provides raw access to keyboard GPIOs.
*
* The keyboard matrix is read (by the caller, keyboard_scan.c in ECOS) by
* driving output signals on the column lines and reading the row lines.
*
* This API and any drivers should be removed once we can safely move to using
* the Zephyr kscan API.
*/
#ifndef ZEPHYR_INCLUDE_DRIVERS_CROS_KB_RAW_H_
#define ZEPHYR_INCLUDE_DRIVERS_CROS_KB_RAW_H_
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <zephyr/drivers/gpio.h>
#include "gpio_signal.h"
/*
* When CONFIG_PLATFORM_EC_KEYBOARD_COL2_INVERTED is enabled, the keyboard
* driver must drive the column 2 output to the opposite state. If the keyboard
* driver doesn't support push-pull operation, then the pin is set using the
* GPIO module. Use the presence of the alias node "gpio-kbd-kso2" to determine
* when this code is needed.
*/
#define KBD_KS02_NODE DT_ALIAS(gpio_kbd_kso2)
/**
* @brief CROS Keyboard Raw Driver APIs
* @defgroup cros_kb_raw_interface CROS Keyboard Raw Driver APIs
* @ingroup io_interfaces
* @{
*/
/**
* @cond INTERNAL_HIDDEN
*
* cros keyboard raw driver API definition and system call entry points
*
* (Internal use only.)
*/
typedef int (*cros_kb_raw_api_init)(const struct device *dev);
typedef int (*cros_kb_raw_api_drive_column)(const struct device *dev, int col);
typedef int (*cros_kb_raw_api_read_rows)(const struct device *dev);
typedef int (*cros_kb_raw_api_enable_interrupt)(const struct device *dev,
int enable);
__subsystem struct cros_kb_raw_driver_api {
cros_kb_raw_api_init init;
cros_kb_raw_api_drive_column drive_colum;
cros_kb_raw_api_read_rows read_rows;
cros_kb_raw_api_enable_interrupt enable_interrupt;
};
/**
* @endcond
*/
/**
* @brief Initialize the raw keyboard interface.
*
* Must be called before any other functions in this interface.
*
* @param dev Pointer to the device structure for the keyboard driver instance.
*
* @return 0 If successful.
* @retval -ENOTSUP Not supported api function.
*/
__syscall int cros_kb_raw_init(const struct device *dev);
static inline int z_impl_cros_kb_raw_init(const struct device *dev)
{
const struct cros_kb_raw_driver_api *api =
(const struct cros_kb_raw_driver_api *)dev->api;
if (!api->init) {
return -ENOTSUP;
}
return api->init(dev);
}
/**
* @brief Drive the specified column low.
*
* Other columns are tristated. See enum keyboard_column_index for special
* values for <col>.
*
* @param dev Pointer to the device structure for the keyboard driver instance.
* @param col Specified column is driven to low.
*
* @return 0 If successful.
* @retval -ENOTSUP Not supported api function.
*/
__syscall int cros_kb_raw_drive_column(const struct device *dev, int col);
static inline int z_impl_cros_kb_raw_drive_column(const struct device *dev,
int col)
{
const struct cros_kb_raw_driver_api *api =
(const struct cros_kb_raw_driver_api *)dev->api;
if (!api->drive_colum) {
return -ENOTSUP;
}
return api->drive_colum(dev, col);
}
/**
* @brief Read raw row state.
*
* Bits are 1 if signal is present, 0 if not present.
*
* @param dev Pointer to the device structure for the keyboard driver instance.
*
* @return current raw row state value.
*/
__syscall int cros_kb_raw_read_rows(const struct device *dev);
static inline int z_impl_cros_kb_raw_read_rows(const struct device *dev)
{
const struct cros_kb_raw_driver_api *api =
(const struct cros_kb_raw_driver_api *)dev->api;
if (!api->read_rows) {
return 0;
}
return api->read_rows(dev);
}
/**
* @brief Enable or disable keyboard interrupts.
*
* Enabling interrupts will clear any pending interrupt bits. To avoid missing
* any interrupts that occur between the end of scanning and then, you should
* call cros_kb_raw_read_rows() after this. If it returns non-zero, disable
* interrupts and go back to polling mode instead of waiting for an interrupt.
*
* @param dev Pointer to the device structure for the keyboard driver instance.
* @param enable If 1, enable keyboard interrupt. Otherwise, disable it.
*
* @return 0 If successful.
* @retval -ENOTSUP Not supported api function.
*/
__syscall int cros_kb_raw_enable_interrupt(const struct device *dev,
int enable);
static inline int z_impl_cros_kb_raw_enable_interrupt(const struct device *dev,
int enable)
{
const struct cros_kb_raw_driver_api *api =
(const struct cros_kb_raw_driver_api *)dev->api;
if (!api->enable_interrupt) {
return -ENOTSUP;
}
return api->enable_interrupt(dev, enable);
}
/**
* @brief Set the logical level of the keyboard column 2 output.
*
* When CONFIG_PLATFORM_EC_KEYBOARD_COL2_INVERTED is enabled, the column 2
* output connects to the Google Security Chip and must use push-pull operation.
* Typically the column 2 signal is also inverted in this configuration so the
* board devicetree should set the GPIO_ACTIVE_LOW flag on GPIO pointed to by
* gpio-kbd-kso2.
*
* @param value Logical level to set to the pin
*/
static inline void cros_kb_raw_set_col2(int level)
{
#if defined CONFIG_PLATFORM_EC_KEYBOARD_COL2_INVERTED && \
DT_NODE_EXISTS(KBD_KS02_NODE)
const struct gpio_dt_spec *kbd_dt_spec =
GPIO_DT_FROM_NODE(KBD_KS02_NODE);
gpio_pin_set(kbd_dt_spec->port, kbd_dt_spec->pin, level);
#endif
}
/**
* @}
*/
#include <syscalls/cros_kb_raw.h>
#endif /* ZEPHYR_INCLUDE_DRIVERS_CROS_KB_RAW_H_ */
|
