Merge pull request #735 from FrameworkComputer/azalea.i2chid

dual i2c hid interface

Author: kiram9

zephyr/dts/bindings/i2c/cros-ec,i2c-target-hid.yaml

@@ -0,0 +1,54 @@
+# SPDX-License-Identifier: Apache-2.0
+
+description: |
+  Zephyr I2C target HID implements the i2c-hid
+  protocol as a i2c slave device.
+
+compatible: "cros-ec,i2c-target-hid"
+
+include: [i2c-device.yaml]
+
+properties:
+  reg:
+    required: true
+
+  max_report_size:
+    type: int
+    required: true
+
+  alert_gpios:
+    required: true
+    type: phandle-array
+    description:
+      Active low GPIO to notify the i2c master to
+      service a request.
+
+  hid_descriptor:
+    type: string
+    description:
+      The C function name that will be called to
+      populate the hid report
+
+  hid_report_descriptor:
+    type: string
+    description:
+      The C function name that will be called to
+      populate the hid report
+
+  get_report_handler:
+    type: string
+    description:
+      The C function name that will be called to
+      populate the hid report
+
+  set_report_handler:
+    type: string
+    description:
+      The C function name that will be called to
+      act on a set report from the host
+
+  power_state_handler:
+    type: string
+    description:
+      The C function name that will be called when
+      the host updates the power state

zephyr/program/lotus/CMakeLists.txt

@@ -14,6 +14,8 @@ zephyr_library_sources("src/factory.c")
 zephyr_library_sources("src/diagnostics.c")
 zephyr_library_sources("src/ucsi.c")
 zephyr_library_sources("src/als.c")
+zephyr_library_sources("src/hid_device.c")
+
 
 zephyr_library_sources_ifdef(CONFIG_PLATFORM_EC_LED_COMMON
 	"src/led_pwm.c")

zephyr/program/lotus/azalea/gpio.dtsi

@@ -151,9 +151,12 @@
 		i2c_int_tp_l {
 			gpios = <&gpioa 4 GPIO_INPUT>;		/* HUB board TP module */
 		};
-		apu_ec_int_l {
+		gpio_apu_ec_int_l: apu_ec_int_l {
 			gpios = <&gpio9 6 GPIO_ODR_HIGH>;	/* EC notify host HID interrupt */
 		};
+		gpio_apu_ec_int2_l: apu_ec_int2_l {
+			gpios = <&gpio7 4 GPIO_ODR_HIGH>;	/* EC notify host HID interrupt 2*/
+		};
 		cam_sw {
 			gpios = <&gpio9 3 GPIO_INPUT>;
 		};

zephyr/program/lotus/azalea/i2c.dtsi

@@ -56,7 +56,24 @@
 	pinctrl-0 = <&i2c0_0_sda_scl_gpb4_b5>;
 	pinctrl-names = "default";
 
-	/* TODO: Add the device on this bus */
+	i2chid0: i2chid@50 {
+		compatible = "cros-ec,i2c-target-hid";
+		reg = <0x50>;
+		alert_gpios = <&gpio9 6 GPIO_OPEN_DRAIN>;
+		max_report_size = <32>;
+		hid_descriptor = "keyboard_hid_desc";
+		hid_report_descriptor = "keyboard_report_desc";
+	};
+
+	i2chid1: i2chid@51 {
+		compatible = "cros-ec,i2c-target-hid";
+		reg = <0x51>;
+		alert_gpios = <&gpio7 4 GPIO_OPEN_DRAIN>;
+		max_report_size = <32>;
+		hid_descriptor = "als_hid_desc";
+		hid_report_descriptor = "als_report_desc";
+	};
+
 };
 
 &i2c_ctrl0 {

zephyr/program/lotus/azalea/overlay.dtsi

@@ -3,6 +3,9 @@
  * found in the LICENSE file.
  */
 
+#include <freq.h>
+
+
 / {
 	named-gpios {
 		/* Lotus-specific GPIO customizations */
@@ -158,5 +161,3 @@
 	>;
 	pinctrl-names = "default";
 };
-
-

zephyr/program/lotus/azalea/src/keyboard_customization.c

@@ -18,6 +18,7 @@
 #include "pwm.h"
 #include "hooks.h"
 #include "system.h"
+#include "hid_device.h"
 
 /* Console output macros */
 #define CPUTS(outstr) cputs(CC_KEYBOARD, outstr)
@@ -281,15 +282,13 @@ int hotkey_F1_F12(uint16_t *key_code, uint16_t fn, int8_t pressed)
 		break;
 	case SCANCODE_F7:  /* TODO: DIM_SCREEN */
 		if (fn_table_media_set(pressed, KB_FN_F7)) {
-			/* TODO HID API */
-			/*update_hid_key(HID_KEY_DISPLAY_BRIGHTNESS_DN, pressed);*/
+			hid_consumer(BUTTON_ID_BRIGHTNESS_DECREMENT, pressed);
 			return EC_ERROR_UNIMPLEMENTED;
 		}
 		break;
 	case SCANCODE_F8:  /* TODO: BRIGHTEN_SCREEN */
 		if (fn_table_media_set(pressed, KB_FN_F8)) {
-			/* TODO HID API */
-			/*update_hid_key(HID_KEY_DISPLAY_BRIGHTNESS_UP, pressed);*/
+			hid_consumer(BUTTON_ID_BRIGHTNESS_INCREMENT, pressed);
 			return EC_ERROR_UNIMPLEMENTED;
 		}
 		break;
@@ -307,8 +306,7 @@ int hotkey_F1_F12(uint16_t *key_code, uint16_t fn, int8_t pressed)
 		break;
 	case SCANCODE_F10:  /* FLIGHT_MODE */
 		if (fn_table_media_set(pressed, KB_FN_F10)) {
-			/* TODO HID API */
-			/*update_hid_key(HID_KEY_AIRPLANE_MODE, pressed);*/
+			hid_airplane(pressed);
 			return EC_ERROR_UNIMPLEMENTED;
 		}
 		break;

zephyr/program/lotus/include/hid_device.h

@@ -0,0 +1,22 @@
+/* Copyright 2021 The ChromiumOS Authors
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#ifndef __CROS_EC_I2C_HID_DEVICE_H
+#define __CROS_EC_I2C_HID_DEVICE_H
+
+#include "util.h"
+
+/*
+ * See hid usage tables for consumer page
+ * https://www.usb.org/hid
+ */
+#define BUTTON_ID_BRIGHTNESS_INCREMENT 0x006F
+#define BUTTON_ID_BRIGHTNESS_DECREMENT 0x0070
+
+void hid_consumer(uint16_t  id, bool pressed);
+void hid_airplane(bool pressed);
+
+
+#endif /* __CROS_EC_I2C_HID_DEVICE_H */

zephyr/program/lotus/lotus/gpio.dtsi

@@ -120,8 +120,8 @@
 		gpio_gpu_vsys_vadp_en: gpu_vsys_vadp_en {
 			gpios = <&gpio1 5 GPIO_OUTPUT_LOW>;	/* Enable GPIO Vsys/VADP PWR */
 		};
-		apu_ec_int_l {
-			gpios = <&gpio1 4 GPIO_ODR_LOW>;	/* HID over I2C interrupt */
+		gpio_apu_ec_int_l: apu_ec_int_l {
+			gpios = <&gpio1 4 GPIO_ODR_HIGH>;	/* HID over I2C interrupt */
 		};
 		ec_disen2 {
 			gpios = <&gpio1 3 GPIO_OUTPUT_LOW>;	/* Disable LM5143 Ph2 */

zephyr/program/lotus/lotus/i2c.dtsi

@@ -67,7 +67,14 @@
 	pinctrl-0 = <&i2c0_0_sda_scl_gpb4_b5>;
 	pinctrl-names = "default";
 
-	/* TODO: Add the device on this bus */
+	i2chid1: i2chid@51 {
+		compatible = "cros-ec,i2c-target-hid";
+		reg = <0x51>;
+		alert_gpios = <&gpio1 4 GPIO_OPEN_DRAIN>;
+		max_report_size = <32>;
+		hid_descriptor = "als_hid_desc";
+		hid_report_descriptor = "als_report_desc";
+	};
 };
 
 &i2c_ctrl0 {

zephyr/program/lotus/program.conf

@@ -86,3 +86,6 @@ CONFIG_PLATFORM_EC_LED_DT=n
 CONFIG_PLATFORM_EC_BACKLIGHT_LID=n
 CONFIG_PLATFORM_EC_VBOOT_EFS2=n
 CONFIG_PLATFORM_EC_CBI=n
+
+#i2c hid
+CONFIG_I2C_TARGET=y