* [PATCH v4 1/2] dt-bindings: input: Create macros for cros-ec keymap
@ 2021-01-09 1:23 Philip Chen
2021-01-09 1:23 ` [PATCH v4 2/2] ARM: dts: cros-ec-keyboard: Use keymap marcos Philip Chen
` (2 more replies)
0 siblings, 3 replies; 7+ messages in thread
From: Philip Chen @ 2021-01-09 1:23 UTC (permalink / raw)
To: LKML, dmitry.torokhov
Cc: dianders, swboyd, Philip Chen, Benson Leung,
Enric Balletbo i Serra, Guenter Roeck, Rob Herring, devicetree
In Chrome OS, the keyboard matrix can be split to two groups:
The keymap for the top row keys can be customized based on OEM
preference, while the keymap for the other keys is generic/fixed
across boards.
This patch creates marcos for the keymaps of these two groups, making
it easier to reuse the generic portion of keymap when we override the
keymap in the board-specific dts for custom top row design.
Signed-off-by: Philip Chen <philipchen@chromium.org>
---
(no changes since v2)
Changes in v2:
- Rename CROS_STD_NON_TOP_ROW_KEYMAP to CROS_STD_MAIN_KEYMAP
include/dt-bindings/input/cros-ec-keyboard.h | 103 +++++++++++++++++++
1 file changed, 103 insertions(+)
create mode 100644 include/dt-bindings/input/cros-ec-keyboard.h
diff --git a/include/dt-bindings/input/cros-ec-keyboard.h b/include/dt-bindings/input/cros-ec-keyboard.h
new file mode 100644
index 0000000000000..a37a8c5701219
--- /dev/null
+++ b/include/dt-bindings/input/cros-ec-keyboard.h
@@ -0,0 +1,103 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * This header provides the constants of the standard Chrome OS key matrix
+ * for cros-ec keyboard-controller bindings.
+ *
+ * Copyright (c) 2021 Google, Inc
+ */
+
+#ifndef _CROS_EC_KEYBOARD_H
+#define _CROS_EC_KEYBOARD_H
+
+#define CROS_STD_TOP_ROW_KEYMAP \
+ MATRIX_KEY(0x00, 0x02, KEY_F1) \
+ MATRIX_KEY(0x03, 0x02, KEY_F2) \
+ MATRIX_KEY(0x02, 0x02, KEY_F3) \
+ MATRIX_KEY(0x01, 0x02, KEY_F4) \
+ MATRIX_KEY(0x03, 0x04, KEY_F5) \
+ MATRIX_KEY(0x02, 0x04, KEY_F6) \
+ MATRIX_KEY(0x01, 0x04, KEY_F7) \
+ MATRIX_KEY(0x02, 0x09, KEY_F8) \
+ MATRIX_KEY(0x01, 0x09, KEY_F9) \
+ MATRIX_KEY(0x00, 0x04, KEY_F10) \
+ MATRIX_KEY(0x03, 0x09, KEY_F13)
+
+#define CROS_STD_MAIN_KEYMAP \
+ MATRIX_KEY(0x00, 0x01, KEY_LEFTMETA) \
+ MATRIX_KEY(0x00, 0x03, KEY_B) \
+ MATRIX_KEY(0x00, 0x05, KEY_RO) \
+ MATRIX_KEY(0x00, 0x06, KEY_N) \
+ MATRIX_KEY(0x00, 0x08, KEY_EQUAL) \
+ MATRIX_KEY(0x00, 0x0a, KEY_RIGHTALT) \
+ MATRIX_KEY(0x01, 0x01, KEY_ESC) \
+ MATRIX_KEY(0x01, 0x03, KEY_G) \
+ MATRIX_KEY(0x01, 0x06, KEY_H) \
+ MATRIX_KEY(0x01, 0x08, KEY_APOSTROPHE) \
+ MATRIX_KEY(0x01, 0x0b, KEY_BACKSPACE) \
+ MATRIX_KEY(0x01, 0x0c, KEY_HENKAN) \
+ \
+ MATRIX_KEY(0x02, 0x00, KEY_LEFTCTRL) \
+ MATRIX_KEY(0x02, 0x01, KEY_TAB) \
+ MATRIX_KEY(0x02, 0x03, KEY_T) \
+ MATRIX_KEY(0x02, 0x05, KEY_RIGHTBRACE) \
+ MATRIX_KEY(0x02, 0x06, KEY_Y) \
+ MATRIX_KEY(0x02, 0x07, KEY_102ND) \
+ MATRIX_KEY(0x02, 0x08, KEY_LEFTBRACE) \
+ MATRIX_KEY(0x02, 0x0a, KEY_YEN) \
+ \
+ MATRIX_KEY(0x03, 0x00, KEY_LEFTMETA) \
+ MATRIX_KEY(0x03, 0x01, KEY_GRAVE) \
+ MATRIX_KEY(0x03, 0x03, KEY_5) \
+ MATRIX_KEY(0x03, 0x06, KEY_6) \
+ MATRIX_KEY(0x03, 0x08, KEY_MINUS) \
+ MATRIX_KEY(0x03, 0x0b, KEY_BACKSLASH) \
+ MATRIX_KEY(0x03, 0x0c, KEY_MUHENKAN) \
+ \
+ MATRIX_KEY(0x04, 0x00, KEY_RIGHTCTRL) \
+ MATRIX_KEY(0x04, 0x01, KEY_A) \
+ MATRIX_KEY(0x04, 0x02, KEY_D) \
+ MATRIX_KEY(0x04, 0x03, KEY_F) \
+ MATRIX_KEY(0x04, 0x04, KEY_S) \
+ MATRIX_KEY(0x04, 0x05, KEY_K) \
+ MATRIX_KEY(0x04, 0x06, KEY_J) \
+ MATRIX_KEY(0x04, 0x08, KEY_SEMICOLON) \
+ MATRIX_KEY(0x04, 0x09, KEY_L) \
+ MATRIX_KEY(0x04, 0x0a, KEY_BACKSLASH) \
+ MATRIX_KEY(0x04, 0x0b, KEY_ENTER) \
+ \
+ MATRIX_KEY(0x05, 0x01, KEY_Z) \
+ MATRIX_KEY(0x05, 0x02, KEY_C) \
+ MATRIX_KEY(0x05, 0x03, KEY_V) \
+ MATRIX_KEY(0x05, 0x04, KEY_X) \
+ MATRIX_KEY(0x05, 0x05, KEY_COMMA) \
+ MATRIX_KEY(0x05, 0x06, KEY_M) \
+ MATRIX_KEY(0x05, 0x07, KEY_LEFTSHIFT) \
+ MATRIX_KEY(0x05, 0x08, KEY_SLASH) \
+ MATRIX_KEY(0x05, 0x09, KEY_DOT) \
+ MATRIX_KEY(0x05, 0x0b, KEY_SPACE) \
+ \
+ MATRIX_KEY(0x06, 0x01, KEY_1) \
+ MATRIX_KEY(0x06, 0x02, KEY_3) \
+ MATRIX_KEY(0x06, 0x03, KEY_4) \
+ MATRIX_KEY(0x06, 0x04, KEY_2) \
+ MATRIX_KEY(0x06, 0x05, KEY_8) \
+ MATRIX_KEY(0x06, 0x06, KEY_7) \
+ MATRIX_KEY(0x06, 0x08, KEY_0) \
+ MATRIX_KEY(0x06, 0x09, KEY_9) \
+ MATRIX_KEY(0x06, 0x0a, KEY_LEFTALT) \
+ MATRIX_KEY(0x06, 0x0b, KEY_DOWN) \
+ MATRIX_KEY(0x06, 0x0c, KEY_RIGHT) \
+ \
+ MATRIX_KEY(0x07, 0x01, KEY_Q) \
+ MATRIX_KEY(0x07, 0x02, KEY_E) \
+ MATRIX_KEY(0x07, 0x03, KEY_R) \
+ MATRIX_KEY(0x07, 0x04, KEY_W) \
+ MATRIX_KEY(0x07, 0x05, KEY_I) \
+ MATRIX_KEY(0x07, 0x06, KEY_U) \
+ MATRIX_KEY(0x07, 0x07, KEY_RIGHTSHIFT) \
+ MATRIX_KEY(0x07, 0x08, KEY_P) \
+ MATRIX_KEY(0x07, 0x09, KEY_O) \
+ MATRIX_KEY(0x07, 0x0b, KEY_UP) \
+ MATRIX_KEY(0x07, 0x0c, KEY_LEFT)
+
+#endif /* _CROS_EC_KEYBOARD_H */
--
2.26.2
^ permalink raw reply related [flat|nested] 7+ messages in thread
* [PATCH v4 2/2] ARM: dts: cros-ec-keyboard: Use keymap marcos
2021-01-09 1:23 [PATCH v4 1/2] dt-bindings: input: Create macros for cros-ec keymap Philip Chen
@ 2021-01-09 1:23 ` Philip Chen
2021-01-12 2:07 ` Stephen Boyd
2021-01-12 2:07 ` Stephen Boyd
2021-01-12 2:06 ` [PATCH v4 1/2] dt-bindings: input: Create macros for cros-ec keymap Stephen Boyd
2021-01-13 15:30 ` Rob Herring
2 siblings, 2 replies; 7+ messages in thread
From: Philip Chen @ 2021-01-09 1:23 UTC (permalink / raw)
To: LKML, dmitry.torokhov
Cc: dianders, swboyd, Philip Chen, Benson Leung,
Enric Balletbo i Serra, Guenter Roeck, Rob Herring, devicetree
The common cros-ec keymap has been defined as macros. This patch uses
the macros to simply linux,keymap in cros-ec-keyboard.dtsi file.
This patch also creates an alias for keyboard-controller to make it
easier to override the keymap in board-specific dts later.
Signed-off-by: Philip Chen <philipchen@chromium.org>
---
Changes in v4:
- Fix a typo
Changes in v3:
- Create an alias for keyboard-controller
Changes in v2:
- Replace CROS_STD_NON_TOP_ROW_KEYMAP with CROS_STD_MAIN_KEYMAP
arch/arm/boot/dts/cros-ec-keyboard.dtsi | 93 ++-----------------------
1 file changed, 4 insertions(+), 89 deletions(-)
diff --git a/arch/arm/boot/dts/cros-ec-keyboard.dtsi b/arch/arm/boot/dts/cros-ec-keyboard.dtsi
index 165c5bcd510e5..55c4744fa7e7a 100644
--- a/arch/arm/boot/dts/cros-ec-keyboard.dtsi
+++ b/arch/arm/boot/dts/cros-ec-keyboard.dtsi
@@ -6,103 +6,18 @@
*/
#include <dt-bindings/input/input.h>
+#include <dt-bindings/input/cros-ec-keyboard.h>
&cros_ec {
- keyboard-controller {
+ keyboard_controller: keyboard-controller {
compatible = "google,cros-ec-keyb";
keypad,num-rows = <8>;
keypad,num-columns = <13>;
google,needs-ghost-filter;
linux,keymap = <
- MATRIX_KEY(0x00, 0x01, KEY_LEFTMETA)
- MATRIX_KEY(0x00, 0x02, KEY_F1)
- MATRIX_KEY(0x00, 0x03, KEY_B)
- MATRIX_KEY(0x00, 0x04, KEY_F10)
- MATRIX_KEY(0x00, 0x05, KEY_RO)
- MATRIX_KEY(0x00, 0x06, KEY_N)
- MATRIX_KEY(0x00, 0x08, KEY_EQUAL)
- MATRIX_KEY(0x00, 0x0a, KEY_RIGHTALT)
-
- MATRIX_KEY(0x01, 0x01, KEY_ESC)
- MATRIX_KEY(0x01, 0x02, KEY_F4)
- MATRIX_KEY(0x01, 0x03, KEY_G)
- MATRIX_KEY(0x01, 0x04, KEY_F7)
- MATRIX_KEY(0x01, 0x06, KEY_H)
- MATRIX_KEY(0x01, 0x08, KEY_APOSTROPHE)
- MATRIX_KEY(0x01, 0x09, KEY_F9)
- MATRIX_KEY(0x01, 0x0b, KEY_BACKSPACE)
- MATRIX_KEY(0x01, 0x0c, KEY_HENKAN)
-
- MATRIX_KEY(0x02, 0x00, KEY_LEFTCTRL)
- MATRIX_KEY(0x02, 0x01, KEY_TAB)
- MATRIX_KEY(0x02, 0x02, KEY_F3)
- MATRIX_KEY(0x02, 0x03, KEY_T)
- MATRIX_KEY(0x02, 0x04, KEY_F6)
- MATRIX_KEY(0x02, 0x05, KEY_RIGHTBRACE)
- MATRIX_KEY(0x02, 0x06, KEY_Y)
- MATRIX_KEY(0x02, 0x07, KEY_102ND)
- MATRIX_KEY(0x02, 0x08, KEY_LEFTBRACE)
- MATRIX_KEY(0x02, 0x09, KEY_F8)
- MATRIX_KEY(0x02, 0x0a, KEY_YEN)
-
- MATRIX_KEY(0x03, 0x00, KEY_LEFTMETA)
- MATRIX_KEY(0x03, 0x01, KEY_GRAVE)
- MATRIX_KEY(0x03, 0x02, KEY_F2)
- MATRIX_KEY(0x03, 0x03, KEY_5)
- MATRIX_KEY(0x03, 0x04, KEY_F5)
- MATRIX_KEY(0x03, 0x06, KEY_6)
- MATRIX_KEY(0x03, 0x08, KEY_MINUS)
- MATRIX_KEY(0x03, 0x09, KEY_F13)
- MATRIX_KEY(0x03, 0x0b, KEY_BACKSLASH)
- MATRIX_KEY(0x03, 0x0c, KEY_MUHENKAN)
-
- MATRIX_KEY(0x04, 0x00, KEY_RIGHTCTRL)
- MATRIX_KEY(0x04, 0x01, KEY_A)
- MATRIX_KEY(0x04, 0x02, KEY_D)
- MATRIX_KEY(0x04, 0x03, KEY_F)
- MATRIX_KEY(0x04, 0x04, KEY_S)
- MATRIX_KEY(0x04, 0x05, KEY_K)
- MATRIX_KEY(0x04, 0x06, KEY_J)
- MATRIX_KEY(0x04, 0x08, KEY_SEMICOLON)
- MATRIX_KEY(0x04, 0x09, KEY_L)
- MATRIX_KEY(0x04, 0x0a, KEY_BACKSLASH)
- MATRIX_KEY(0x04, 0x0b, KEY_ENTER)
-
- MATRIX_KEY(0x05, 0x01, KEY_Z)
- MATRIX_KEY(0x05, 0x02, KEY_C)
- MATRIX_KEY(0x05, 0x03, KEY_V)
- MATRIX_KEY(0x05, 0x04, KEY_X)
- MATRIX_KEY(0x05, 0x05, KEY_COMMA)
- MATRIX_KEY(0x05, 0x06, KEY_M)
- MATRIX_KEY(0x05, 0x07, KEY_LEFTSHIFT)
- MATRIX_KEY(0x05, 0x08, KEY_SLASH)
- MATRIX_KEY(0x05, 0x09, KEY_DOT)
- MATRIX_KEY(0x05, 0x0b, KEY_SPACE)
-
- MATRIX_KEY(0x06, 0x01, KEY_1)
- MATRIX_KEY(0x06, 0x02, KEY_3)
- MATRIX_KEY(0x06, 0x03, KEY_4)
- MATRIX_KEY(0x06, 0x04, KEY_2)
- MATRIX_KEY(0x06, 0x05, KEY_8)
- MATRIX_KEY(0x06, 0x06, KEY_7)
- MATRIX_KEY(0x06, 0x08, KEY_0)
- MATRIX_KEY(0x06, 0x09, KEY_9)
- MATRIX_KEY(0x06, 0x0a, KEY_LEFTALT)
- MATRIX_KEY(0x06, 0x0b, KEY_DOWN)
- MATRIX_KEY(0x06, 0x0c, KEY_RIGHT)
-
- MATRIX_KEY(0x07, 0x01, KEY_Q)
- MATRIX_KEY(0x07, 0x02, KEY_E)
- MATRIX_KEY(0x07, 0x03, KEY_R)
- MATRIX_KEY(0x07, 0x04, KEY_W)
- MATRIX_KEY(0x07, 0x05, KEY_I)
- MATRIX_KEY(0x07, 0x06, KEY_U)
- MATRIX_KEY(0x07, 0x07, KEY_RIGHTSHIFT)
- MATRIX_KEY(0x07, 0x08, KEY_P)
- MATRIX_KEY(0x07, 0x09, KEY_O)
- MATRIX_KEY(0x07, 0x0b, KEY_UP)
- MATRIX_KEY(0x07, 0x0c, KEY_LEFT)
+ CROS_STD_TOP_ROW_KEYMAP
+ CROS_STD_MAIN_KEYMAP
>;
};
};
--
2.26.2
^ permalink raw reply related [flat|nested] 7+ messages in thread
* Re: [PATCH v4 1/2] dt-bindings: input: Create macros for cros-ec keymap
2021-01-09 1:23 [PATCH v4 1/2] dt-bindings: input: Create macros for cros-ec keymap Philip Chen
2021-01-09 1:23 ` [PATCH v4 2/2] ARM: dts: cros-ec-keyboard: Use keymap marcos Philip Chen
@ 2021-01-12 2:06 ` Stephen Boyd
2021-01-13 15:30 ` Rob Herring
2 siblings, 0 replies; 7+ messages in thread
From: Stephen Boyd @ 2021-01-12 2:06 UTC (permalink / raw)
To: LKML, Philip Chen, dmitry.torokhov
Cc: dianders, Philip Chen, Benson Leung, Enric Balletbo i Serra,
Guenter Roeck, Rob Herring, devicetree
Quoting Philip Chen (2021-01-08 17:23:31)
> In Chrome OS, the keyboard matrix can be split to two groups:
>
> The keymap for the top row keys can be customized based on OEM
> preference, while the keymap for the other keys is generic/fixed
> across boards.
>
> This patch creates marcos for the keymaps of these two groups, making
> it easier to reuse the generic portion of keymap when we override the
> keymap in the board-specific dts for custom top row design.
>
> Signed-off-by: Philip Chen <philipchen@chromium.org>
> ---
Reviewed-by: Stephen Boyd <swboyd@chromium.org>
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH v4 2/2] ARM: dts: cros-ec-keyboard: Use keymap marcos
2021-01-09 1:23 ` [PATCH v4 2/2] ARM: dts: cros-ec-keyboard: Use keymap marcos Philip Chen
@ 2021-01-12 2:07 ` Stephen Boyd
2021-01-12 2:07 ` Stephen Boyd
1 sibling, 0 replies; 7+ messages in thread
From: Stephen Boyd @ 2021-01-12 2:07 UTC (permalink / raw)
To: LKML, Philip Chen, dmitry.torokhov
Cc: dianders, Philip Chen, Benson Leung, Enric Balletbo i Serra,
Guenter Roeck, Rob Herring, devicetree
Quoting Philip Chen (2021-01-08 17:23:32)
> The common cros-ec keymap has been defined as macros. This patch uses
> the macros to simply linux,keymap in cros-ec-keyboard.dtsi file.
>
> This patch also creates an alias for keyboard-controller to make it
> easier to override the keymap in board-specific dts later.
>
> Signed-off-by: Philip Chen <philipchen@chromium.org>
> ---
Reviewed-by: Stephen Boyd <swboyd@chromium.org>
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH v4 2/2] ARM: dts: cros-ec-keyboard: Use keymap marcos
2021-01-09 1:23 ` [PATCH v4 2/2] ARM: dts: cros-ec-keyboard: Use keymap marcos Philip Chen
2021-01-12 2:07 ` Stephen Boyd
@ 2021-01-12 2:07 ` Stephen Boyd
2021-01-13 22:15 ` Philip Chen
1 sibling, 1 reply; 7+ messages in thread
From: Stephen Boyd @ 2021-01-12 2:07 UTC (permalink / raw)
To: LKML, Philip Chen, dmitry.torokhov
Cc: dianders, Philip Chen, Benson Leung, Enric Balletbo i Serra,
Guenter Roeck, Rob Herring, devicetree
BTW, subject says 'marcos' when it should say 'macros'
Quoting Philip Chen (2021-01-08 17:23:32)
> The common cros-ec keymap has been defined as macros. This patch uses
> the macros to simply linux,keymap in cros-ec-keyboard.dtsi file.
>
> This patch also creates an alias for keyboard-controller to make it
> easier to override the keymap in board-specific dts later.
>
> Signed-off-by: Philip Chen <philipchen@chromium.org>
> ---
>
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH v4 1/2] dt-bindings: input: Create macros for cros-ec keymap
2021-01-09 1:23 [PATCH v4 1/2] dt-bindings: input: Create macros for cros-ec keymap Philip Chen
2021-01-09 1:23 ` [PATCH v4 2/2] ARM: dts: cros-ec-keyboard: Use keymap marcos Philip Chen
2021-01-12 2:06 ` [PATCH v4 1/2] dt-bindings: input: Create macros for cros-ec keymap Stephen Boyd
@ 2021-01-13 15:30 ` Rob Herring
2 siblings, 0 replies; 7+ messages in thread
From: Rob Herring @ 2021-01-13 15:30 UTC (permalink / raw)
To: Philip Chen
Cc: swboyd, devicetree, Rob Herring, Benson Leung, Guenter Roeck,
Enric Balletbo i Serra, dianders, dmitry.torokhov, LKML
On Fri, 08 Jan 2021 17:23:31 -0800, Philip Chen wrote:
> In Chrome OS, the keyboard matrix can be split to two groups:
>
> The keymap for the top row keys can be customized based on OEM
> preference, while the keymap for the other keys is generic/fixed
> across boards.
>
> This patch creates marcos for the keymaps of these two groups, making
> it easier to reuse the generic portion of keymap when we override the
> keymap in the board-specific dts for custom top row design.
>
> Signed-off-by: Philip Chen <philipchen@chromium.org>
> ---
>
> (no changes since v2)
>
> Changes in v2:
> - Rename CROS_STD_NON_TOP_ROW_KEYMAP to CROS_STD_MAIN_KEYMAP
>
> include/dt-bindings/input/cros-ec-keyboard.h | 103 +++++++++++++++++++
> 1 file changed, 103 insertions(+)
> create mode 100644 include/dt-bindings/input/cros-ec-keyboard.h
>
Acked-by: Rob Herring <robh@kernel.org>
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH v4 2/2] ARM: dts: cros-ec-keyboard: Use keymap marcos
2021-01-12 2:07 ` Stephen Boyd
@ 2021-01-13 22:15 ` Philip Chen
0 siblings, 0 replies; 7+ messages in thread
From: Philip Chen @ 2021-01-13 22:15 UTC (permalink / raw)
To: Stephen Boyd
Cc: LKML, Dmitry Torokhov, Douglas Anderson, Benson Leung,
Enric Balletbo i Serra, Guenter Roeck, Rob Herring, devicetree
On Mon, Jan 11, 2021 at 6:07 PM Stephen Boyd <swboyd@chromium.org> wrote:
>
> BTW, subject says 'marcos' when it should say 'macros'
Thanks - I fixed it in v5.
>
> Quoting Philip Chen (2021-01-08 17:23:32)
> > The common cros-ec keymap has been defined as macros. This patch uses
> > the macros to simply linux,keymap in cros-ec-keyboard.dtsi file.
> >
> > This patch also creates an alias for keyboard-controller to make it
> > easier to override the keymap in board-specific dts later.
> >
> > Signed-off-by: Philip Chen <philipchen@chromium.org>
> > ---
> >
^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2021-01-14 2:11 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-09 1:23 [PATCH v4 1/2] dt-bindings: input: Create macros for cros-ec keymap Philip Chen
2021-01-09 1:23 ` [PATCH v4 2/2] ARM: dts: cros-ec-keyboard: Use keymap marcos Philip Chen
2021-01-12 2:07 ` Stephen Boyd
2021-01-12 2:07 ` Stephen Boyd
2021-01-13 22:15 ` Philip Chen
2021-01-12 2:06 ` [PATCH v4 1/2] dt-bindings: input: Create macros for cros-ec keymap Stephen Boyd
2021-01-13 15:30 ` Rob Herring
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.