From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from smtp4.osuosl.org (smtp4.osuosl.org [140.211.166.137]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 42C77E95A67 for ; Sun, 8 Oct 2023 18:58:24 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp4.osuosl.org (Postfix) with ESMTP id EBA6141855; Sun, 8 Oct 2023 18:58:23 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp4.osuosl.org EBA6141855 Authentication-Results: smtp4.osuosl.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20230601 header.b=MVBfRrsU X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp4.osuosl.org ([127.0.0.1]) by localhost (smtp4.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id jPRfe4hoD-Sm; Sun, 8 Oct 2023 18:58:20 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [IPv6:2605:bc80:3010:104::8cd3:938]) by smtp4.osuosl.org (Postfix) with ESMTPS id 1E1ED41846; Sun, 8 Oct 2023 18:58:20 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp4.osuosl.org 1E1ED41846 Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id ED7DBC0039; Sun, 8 Oct 2023 18:58:19 +0000 (UTC) Received: from smtp1.osuosl.org (smtp1.osuosl.org [140.211.166.138]) by lists.linuxfoundation.org (Postfix) with ESMTP id C6279C0032 for ; Sun, 8 Oct 2023 18:58:18 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp1.osuosl.org (Postfix) with ESMTP id A19A0820CF for ; Sun, 8 Oct 2023 18:58:18 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp1.osuosl.org A19A0820CF Authentication-Results: smtp1.osuosl.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20230601 header.b=MVBfRrsU X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp1.osuosl.org ([127.0.0.1]) by localhost (smtp1.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id X5wykNiVlF1k for ; Sun, 8 Oct 2023 18:58:16 +0000 (UTC) Received: from mail-oa1-x35.google.com (mail-oa1-x35.google.com [IPv6:2001:4860:4864:20::35]) by smtp1.osuosl.org (Postfix) with ESMTPS id 7CE358208C for ; Sun, 8 Oct 2023 18:58:16 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp1.osuosl.org 7CE358208C Received: by mail-oa1-x35.google.com with SMTP id 586e51a60fabf-1d544a4a2f2so2627465fac.3 for ; Sun, 08 Oct 2023 11:58:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1696791495; x=1697396295; darn=lists.linuxfoundation.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=yvv4HLX2+4XEGXy0uw41xNg3YlLZrx1iRvIS1fEetBY=; b=MVBfRrsU2/ZyIcJAGuX8mpJL9V9dgdQTlLt2LlyyYfwdRAo5fVNP05BOJYMwis85li RTsoz6NXPn1sk0C1wqqDRtGPzs/rIxfNH+V/J9BKz2dNzk1xGte0iSfRyRlOnGQCKvmo 9ijOmKztWVqAgjVtKEee1PXZ/1vOviTU6r2oMtBSppumbPeoYhNkQvzlUMADFi4UYS5W 7xaeeXh7ccsfIwRpY+aLY7kklFqKsze+K5Ro7xHHeuDgyDRsGvXUEp1ihFTCt65qjNXw s2c3Rvjaj/6ZIsn3aqBLH38VlKAODljsE/nWMsNVEGbLBKENWPr4jOT4WM8ZPxmxPWBn HxoA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1696791495; x=1697396295; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=yvv4HLX2+4XEGXy0uw41xNg3YlLZrx1iRvIS1fEetBY=; b=mlbjOpQNa0aSiHrehN9Cniw/5odhNxtZrn92032YWA/dIQhnLEI4GZREuTF0QGDPLW P+vM8RE+MwojpIOusGi2oAfBwT6Il97+yW9YiHwnLGHqUYaZv7ouAwZs1aYz+2Ql7l8C vER/DY7+nRj2rQGUmjnyWczl1GvKhczPZDxWid2vFd4XwDA7FwStoNAdqbnfmhgs24gC d4tUxMhivddsCLDprMxfQ/TnnpaySZkXzkjEplV9q7wXIFNEBTxEWSLETPLxdJv8sCUK XmUQbNMabgILL3EPwUPLc8DuvI+LdmAwqbx34DuLN3xVRm91DTBtR2EVw/YyS9cgbS95 X39A== X-Gm-Message-State: AOJu0YyRVGd4onc3cuXi/pM0q3J6EbqKEc5nULjcMW2gQq75fTZ4ZVog 4clqFaUfRAxh5+fSpwcDLmA= X-Google-Smtp-Source: AGHT+IE/Gn4SNRncIbCpAP+mhH94rz2Q8hgSHHfRJahi60TtJ/ONgCiamEDSP7kNcVw89t91LRKr+Q== X-Received: by 2002:a05:6870:390e:b0:1d6:c780:8b59 with SMTP id b14-20020a056870390e00b001d6c7808b59mr15465552oap.53.1696791495107; Sun, 08 Oct 2023 11:58:15 -0700 (PDT) Received: from archlinux.srmu.edu.in ([14.139.187.71]) by smtp.gmail.com with ESMTPSA id ij8-20020a170902ab4800b001bdd68b3f4bsm7906882plb.295.2023.10.08.11.58.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 08 Oct 2023 11:58:14 -0700 (PDT) From: Anshul Dalal To: linux-input@vger.kernel.org, devicetree@vger.kernel.org Subject: [PATCH v3 2/2] input: joystick: driver for Adafruit Seesaw Gamepad Date: Mon, 9 Oct 2023 00:27:07 +0530 Message-ID: <20231008185709.2448423-2-anshulusr@gmail.com> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231008185709.2448423-1-anshulusr@gmail.com> References: <20231008185709.2448423-1-anshulusr@gmail.com> MIME-Version: 1.0 Cc: Conor Dooley , Anshul Dalal , Dmitry Torokhov , Rob Herring , Krzysztof Kozlowski , linux-kernel-mentees@lists.linuxfoundation.org X-BeenThere: linux-kernel-mentees@lists.linuxfoundation.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: linux-kernel-mentees-bounces@lists.linuxfoundation.org Sender: "Linux-kernel-mentees" A simple driver for a mini gamepad that communicates over i2c, the gamepad has bidirectional thumb stick input and six buttons. The gamepad chip utilizes the open framework from Adafruit called 'Seesaw' to transmit the ADC data for the joystick and digital pin state for the buttons. I have only implemented the functionality required to receive the thumb stick and button state. Steps in reading the gamepad state over i2c: 1. Reset the registers 2. Set the pin mode of the pins specified by the `BUTTON_MASK` to input `BUTTON_MASK`: A bit-map for the six digital pins internally connected to the joystick buttons. 3. Enable internal pullup resistors for the `BUTTON_MASK` 4. Bulk set the pin state HIGH for `BUTTON_MASK` 5. Poll the device for button and joystick state done by: `seesaw_read_data(struct i2c_client *client, struct seesaw_data *data)` Product page: https://www.adafruit.com/product/5743 Arduino driver: https://github.com/adafruit/Adafruit_Seesaw Driver tested on RPi Zero 2W Signed-off-by: Anshul Dalal --- Changes for v3: - no updates Changes for v2: adafruit-seesaw.c: - Renamed file from 'adafruit_seesaw.c' - Changed device name from 'seesaw_gamepad' to 'seesaw-gamepad' - Changed count parameter for receiving joystick x on line 118: `2` to `sizeof(write_buf)` - Fixed invalid buffer size on line 123 and 126: `data->y` to `sizeof(data->y)` - Added comment for the `mdelay(10)` on line 169 - Changed inconsistent indentation on line 271 Kconfig: - Fixed indentation for the help text - Updated module name Makefile: - Updated module object file name MAINTAINERS: - Updated file name for the driver and bindings MAINTAINERS | 7 + drivers/input/joystick/Kconfig | 9 + drivers/input/joystick/Makefile | 1 + drivers/input/joystick/adafruit-seesaw.c | 277 +++++++++++++++++++++++ 4 files changed, 294 insertions(+) create mode 100644 drivers/input/joystick/adafruit-seesaw.c diff --git a/MAINTAINERS b/MAINTAINERS index 6c4cce45a09d..a314f9b48e21 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -441,6 +441,13 @@ W: http://wiki.analog.com/AD7879 W: https://ez.analog.com/linux-software-drivers F: drivers/input/touchscreen/ad7879.c +ADAFRUIT MINI I2C GAMEPAD +M: Anshul Dalal +L: linux-input@vger.kernel.org +S: Maintained +F: Documentation/devicetree/bindings/input/adafruit,seesaw-gamepad.yaml +F: drivers/input/joystick/adafruit-seesaw.c + ADDRESS SPACE LAYOUT RANDOMIZATION (ASLR) M: Jiri Kosina S: Maintained diff --git a/drivers/input/joystick/Kconfig b/drivers/input/joystick/Kconfig index ac6925ce8366..df9cd1830b29 100644 --- a/drivers/input/joystick/Kconfig +++ b/drivers/input/joystick/Kconfig @@ -412,4 +412,13 @@ config JOYSTICK_SENSEHAT To compile this driver as a module, choose M here: the module will be called sensehat_joystick. +config JOYSTICK_SEESAW + tristate "Adafruit Mini I2C Gamepad with Seesaw" + depends on I2C + help + Say Y here if you want to use the Adafruit Mini I2C Gamepad. + + To compile this driver as a module, choose M here: the module will be + called adafruit-seesaw. + endif diff --git a/drivers/input/joystick/Makefile b/drivers/input/joystick/Makefile index 3937535f0098..9976f596a920 100644 --- a/drivers/input/joystick/Makefile +++ b/drivers/input/joystick/Makefile @@ -28,6 +28,7 @@ obj-$(CONFIG_JOYSTICK_N64) += n64joy.o obj-$(CONFIG_JOYSTICK_PSXPAD_SPI) += psxpad-spi.o obj-$(CONFIG_JOYSTICK_PXRC) += pxrc.o obj-$(CONFIG_JOYSTICK_QWIIC) += qwiic-joystick.o +obj-$(CONFIG_JOYSTICK_SEESAW) += adafruit-seesaw.o obj-$(CONFIG_JOYSTICK_SENSEHAT) += sensehat-joystick.o obj-$(CONFIG_JOYSTICK_SIDEWINDER) += sidewinder.o obj-$(CONFIG_JOYSTICK_SPACEBALL) += spaceball.o diff --git a/drivers/input/joystick/adafruit-seesaw.c b/drivers/input/joystick/adafruit-seesaw.c new file mode 100644 index 000000000000..1e8b3f5604d8 --- /dev/null +++ b/drivers/input/joystick/adafruit-seesaw.c @@ -0,0 +1,277 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * Copyright (C) 2023 Anshul Dalal + * + * Driver for Adafruit Mini I2C Gamepad + * + * Based on the work of: + * Oleh Kravchenko (Sparkfun Qwiic Joystick driver) + * + * Product page: https://www.adafruit.com/product/5743 + * Firmware and hardware sources: https://github.com/adafruit/Adafruit_Seesaw + */ + +#include +#include +#include +#include +#include +#include + +/* clang-format off */ +#define SEESAW_DEVICE_NAME "seesaw-gamepad" + +#define SEESAW_STATUS_BASE 0 +#define SEESAW_GPIO_BASE 1 +#define SEESAW_ADC_BASE 9 + +#define SEESAW_GPIO_DIRCLR_BULK 3 +#define SEESAW_GPIO_BULK 4 +#define SEESAW_GPIO_BULK_SET 5 +#define SEESAW_GPIO_PULLENSET 11 + +#define SEESAW_STATUS_HW_ID 1 +#define SEESAW_STATUS_SWRST 127 + +#define SEESAW_ADC_OFFSET 7 + +#define BUTTON_A 5 +#define BUTTON_B 1 +#define BUTTON_X 6 +#define BUTTON_Y 2 +#define BUTTON_START 16 +#define BUTTON_SELECT 0 + +#define ANALOG_X 14 +#define ANALOG_Y 15 + +#define SEESAW_JOYSTICK_MAX_AXIS 1023 +#define SEESAW_JOYSTICK_FUZZ 2 +#define SEESAW_JOYSTICK_FLAT 4 + +#define SEESAW_GAMEPAD_POLL_INTERVAL 16 +#define SEESAW_GAMEPAD_POLL_MIN 8 +#define SEESAW_GAMEPAD_POLL_MAX 32 +/* clang-format on */ + +u32 BUTTON_MASK = (1UL << BUTTON_A) | (1UL << BUTTON_B) | (1UL << BUTTON_X) | + (1UL << BUTTON_Y) | (1UL << BUTTON_START) | + (1UL << BUTTON_SELECT); + +struct seesaw_gamepad { + char physical_path[32]; + unsigned char hardware_id; + struct input_dev *input_dev; + struct i2c_client *i2c_client; +}; + +struct seesaw_data { + __be16 x; + __be16 y; + u8 button_a, button_b, button_x, button_y, button_start, button_select; +}; + +static int seesaw_read_data(struct i2c_client *client, struct seesaw_data *data) +{ + int err; + unsigned char write_buf[2] = { SEESAW_GPIO_BASE, SEESAW_GPIO_BULK }; + unsigned char read_buf[4]; + + err = i2c_master_send(client, write_buf, sizeof(write_buf)); + if (err < 0) + return err; + if (err != sizeof(write_buf)) + return -EIO; + err = i2c_master_recv(client, read_buf, sizeof(read_buf)); + if (err < 0) + return err; + if (err != sizeof(read_buf)) + return -EIO; + u32 result = ((u32)read_buf[0] << 24) | ((u32)read_buf[1] << 16) | + ((u32)read_buf[2] << 8) | (u32)read_buf[3]; + data->button_a = !(result & (1UL << BUTTON_A)); + data->button_b = !(result & (1UL << BUTTON_B)); + data->button_x = !(result & (1UL << BUTTON_X)); + data->button_y = !(result & (1UL << BUTTON_Y)); + data->button_start = !(result & (1UL << BUTTON_START)); + data->button_select = !(result & (1UL << BUTTON_SELECT)); + + write_buf[0] = SEESAW_ADC_BASE; + write_buf[1] = SEESAW_ADC_OFFSET + ANALOG_X; + err = i2c_master_send(client, write_buf, sizeof(write_buf)); + if (err < 0) + return err; + if (err != sizeof(write_buf)) + return -EIO; + err = i2c_master_recv(client, (char *)&data->x, sizeof(data->x)); + if (err < 0) + return err; + if (err != sizeof(data->x)) + return -EIO; + /* + * ADC reads left as max and right as 0, must be reversed since kernel + * expects reports in opposite order. + */ + data->x = SEESAW_JOYSTICK_MAX_AXIS - be16_to_cpu(data->x); + + write_buf[1] = SEESAW_ADC_OFFSET + ANALOG_Y; + err = i2c_master_send(client, write_buf, sizeof(write_buf)); + if (err < 0) + return err; + if (err != sizeof(write_buf)) + return -EIO; + err = i2c_master_recv(client, (char *)&data->y, sizeof(data->y)); + if (err < 0) + return err; + if (err != sizeof(data->y)) + return -EIO; + data->y = be16_to_cpu(data->y); + + return 0; +} + +static void seesaw_poll(struct input_dev *input) +{ + struct seesaw_gamepad *private = input_get_drvdata(input); + struct seesaw_data data; + int err; + + err = seesaw_read_data(private->i2c_client, &data); + if (err != 0) + return; + + input_report_abs(input, ABS_X, data.x); + input_report_abs(input, ABS_Y, data.y); + input_report_key(input, BTN_A, data.button_a); + input_report_key(input, BTN_B, data.button_b); + input_report_key(input, BTN_X, data.button_x); + input_report_key(input, BTN_Y, data.button_y); + input_report_key(input, BTN_START, data.button_start); + input_report_key(input, BTN_SELECT, data.button_select); + input_sync(input); +} + +static int seesaw_probe(struct i2c_client *client) +{ + int err; + struct seesaw_gamepad *private; + unsigned char register_reset[] = { SEESAW_STATUS_BASE, + SEESAW_STATUS_SWRST, 0xFF }; + unsigned char get_hw_id[] = { SEESAW_STATUS_BASE, SEESAW_STATUS_HW_ID }; + + err = i2c_master_send(client, register_reset, sizeof(register_reset)); + if (err < 0) + return err; + if (err != sizeof(register_reset)) + return -EIO; + + /* Wait for the registers to reset before proceeding */ + mdelay(10); + + private = devm_kzalloc(&client->dev, sizeof(*private), GFP_KERNEL); + if (!private) + return -ENOMEM; + + err = i2c_master_send(client, get_hw_id, sizeof(get_hw_id)); + if (err < 0) + return err; + if (err != sizeof(get_hw_id)) + return -EIO; + err = i2c_master_recv(client, &private->hardware_id, 1); + if (err < 0) + return err; + if (err != 1) + return -EIO; + + dev_dbg(&client->dev, "Adafruit Seesaw Gamepad, Hardware ID: %02x\n", + private->hardware_id); + + private->i2c_client = client; + scnprintf(private->physical_path, sizeof(private->physical_path), + "i2c/%s", dev_name(&client->dev)); + i2c_set_clientdata(client, private); + + private->input_dev = devm_input_allocate_device(&client->dev); + if (!private->input_dev) + return -ENOMEM; + + private->input_dev->id.bustype = BUS_I2C; + private->input_dev->name = "Adafruit Seesaw Gamepad"; + private->input_dev->phys = private->physical_path; + input_set_drvdata(private->input_dev, private); + input_set_abs_params(private->input_dev, ABS_X, 0, + SEESAW_JOYSTICK_MAX_AXIS, SEESAW_JOYSTICK_FUZZ, + SEESAW_JOYSTICK_FLAT); + input_set_abs_params(private->input_dev, ABS_Y, 0, + SEESAW_JOYSTICK_MAX_AXIS, SEESAW_JOYSTICK_FUZZ, + SEESAW_JOYSTICK_FLAT); + input_set_capability(private->input_dev, EV_KEY, BTN_A); + input_set_capability(private->input_dev, EV_KEY, BTN_B); + input_set_capability(private->input_dev, EV_KEY, BTN_X); + input_set_capability(private->input_dev, EV_KEY, BTN_Y); + input_set_capability(private->input_dev, EV_KEY, BTN_START); + input_set_capability(private->input_dev, EV_KEY, BTN_SELECT); + + err = input_setup_polling(private->input_dev, seesaw_poll); + if (err) { + dev_err(&client->dev, "failed to set up polling: %d\n", err); + return err; + } + + input_set_poll_interval(private->input_dev, + SEESAW_GAMEPAD_POLL_INTERVAL); + input_set_max_poll_interval(private->input_dev, + SEESAW_GAMEPAD_POLL_MAX); + input_set_min_poll_interval(private->input_dev, + SEESAW_GAMEPAD_POLL_MIN); + + err = input_register_device(private->input_dev); + if (err) { + dev_err(&client->dev, "failed to register joystick: %d\n", err); + return err; + } + + /* Set Pin Mode to input and enable pull-up resistors */ + unsigned char pin_mode[] = { SEESAW_GPIO_BASE, SEESAW_GPIO_DIRCLR_BULK, + BUTTON_MASK >> 24, BUTTON_MASK >> 16, + BUTTON_MASK >> 8, BUTTON_MASK }; + err = i2c_master_send(client, pin_mode, sizeof(pin_mode)); + pin_mode[1] = SEESAW_GPIO_PULLENSET; + err |= i2c_master_send(client, pin_mode, sizeof(pin_mode)); + pin_mode[1] = SEESAW_GPIO_BULK_SET; + err |= i2c_master_send(client, pin_mode, sizeof(pin_mode)); + if (err < 0) + return err; + if (err != sizeof(pin_mode)) + return -EIO; + + return 0; +} + +#ifdef CONFIG_OF +static const struct of_device_id of_seesaw_match[] = { + { + .compatible = "adafruit,seesaw-gamepad", + }, + { /* Sentinel */ }, +}; +MODULE_DEVICE_TABLE(of, of_seesaw_match); +#endif /* CONFIG_OF */ + +static const struct i2c_device_id seesaw_id_table[] = { { KBUILD_MODNAME, 0 }, + { /* Sentinel */ } }; +MODULE_DEVICE_TABLE(i2c, seesaw_id_table); + +static struct i2c_driver seesaw_driver = { + .driver = { + .name = SEESAW_DEVICE_NAME, + .of_match_table = of_match_ptr(of_seesaw_match), + }, + .id_table = seesaw_id_table, + .probe = seesaw_probe, +}; +module_i2c_driver(seesaw_driver); + +MODULE_AUTHOR("Anshul Dalal "); +MODULE_DESCRIPTION("Adafruit Mini I2C Gamepad driver"); +MODULE_LICENSE("GPL"); -- 2.42.0 _______________________________________________ Linux-kernel-mentees mailing list Linux-kernel-mentees@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees