summaryrefslogtreecommitdiff
path: root/include/keyboard_protocol.h
blob: a0684a164749fac18387a1d30031b7fd266142a7 (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
/* Copyright (c) 2013 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.
 *
 * Keyboard protocol interface
 */

#ifndef __CROS_EC_KEYBOARD_PROTOCOL_H
#define __CROS_EC_KEYBOARD_PROTOCOL_H

#include "common.h"
#include "button.h"

/* Routines common to all protocols */

/**
 * Clear the keyboard buffer to host.
 */
void keyboard_clear_buffer(void);

/*
 * Respond to button changes. Implemented by a host-specific
 * handler.
 *
 * @param button	The button that changed.
 * @param is_pressed	Whether the button is now pressed.
 */
void keyboard_update_button(enum keyboard_button_type button, int is_pressed);

/*
 * Get the state of supported buttons.
 */
uint32_t keyboard_get_button_state(void);

#ifdef CONFIG_KEYBOARD_DYNAMIC_MAPPING
/* Values to select scancode mapping (need CONFIG_KEYBOARD_DYNAMIC_MAPPING) */
enum keyboard_mapping_type {
	KEYBOARD_MAPPING_CHROMEOS = 0,
	KEYBOARD_MAPPING_LEGACY,
	KEYBOARD_MAPPING_INVALID,

	KEYBOARD_MAPPING_DEFAULT = KEYBOARD_MAPPING_CHROMEOS
};

/**
 * Select and change keyboard mapping.
 *
 * @param mapping	The type of mapping (keyboard_mapping_type).
 */
void keyboard_select_mapping(enum keyboard_mapping_type mapping);

/**
 * Board-specific callback when keyboard mapping is changed.
 *
 * @param new_mapping	The type of mapping to apply (keyboard_mapping_type).
 */
void keyboard_board_mapping_changed(enum keyboard_mapping_type new_mapping);
#endif

/* Protocol-specific includes */

#ifdef CONFIG_KEYBOARD_PROTOCOL_8042
#include "keyboard_8042.h"
#endif

#ifdef CONFIG_KEYBOARD_PROTOCOL_MKBP
#include "keyboard_mkbp.h"

/* MKBP protocol takes the whole keyboard matrix, and does not care about
 * individual key presses.
 */
static inline void keyboard_state_changed(int row, int col, int is_pressed) {}
#else
/**
 * Called by keyboard scan code once any key state change (after de-bounce),
 *
 * This function will look up matrix table and convert scancode host.
 */
void keyboard_state_changed(int row, int col, int is_pressed);
#endif

#endif  /* __CROS_EC_KEYBOARD_PROTOCOL_H */