From patchwork Fri Jun 22 14:22:01 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Loic Poulain X-Patchwork-Id: 10482249 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 1BC53602CB for ; Fri, 22 Jun 2018 14:22:08 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 04AC528F31 for ; Fri, 22 Jun 2018 14:22:08 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id ED0E928F52; Fri, 22 Jun 2018 14:22:07 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI, T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 37A6528F31 for ; Fri, 22 Jun 2018 14:22:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751445AbeFVOWF (ORCPT ); Fri, 22 Jun 2018 10:22:05 -0400 Received: from mail-wr0-f196.google.com ([209.85.128.196]:32851 "EHLO mail-wr0-f196.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751335AbeFVOWE (ORCPT ); Fri, 22 Jun 2018 10:22:04 -0400 Received: by mail-wr0-f196.google.com with SMTP id k16-v6so6916551wro.0 for ; Fri, 22 Jun 2018 07:22:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=2Bbyy6KXJku7PdG/jdBuAml5OMb4oRom1atl3RKWao4=; b=Z9GEFt7nMwuXczUuGgvEie7JQJ83HiltLEPeM2i2RWiPXAW8f3z/hjgGpwRXUefNoO cmPmo2cZ3Ry9VYOf52d15NF80wcb2fxuAGfY3NLJ21RWH60og7nG3Mq4k4GTpl4x89gC JIkwmS/7bR8rFjlPVPqDDet9aMP6z8ZXtSytU= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=2Bbyy6KXJku7PdG/jdBuAml5OMb4oRom1atl3RKWao4=; b=nHnVSBm7trtu65b1z+sUZZUKeNEVypcNc0lL2IaGWvieVSyNYM3xFYp3NiwWsjk9qa qPz5esfz9MVplSutETK6L9Bzsf+ACrcHdDxBT+DZMYh6UTXq7vV69XFdwmcSFTgc/yHh Fg+mxVP9jf2dUa4ItuW09XQjTrM9nl5KWyXCHLQkRPiPnBVLGKDmdzvSyNy9k6TdGM83 2HxPEEl0Rcv8nsvef/FQqQp5e+hrVCGFvaX3ZjtoutZk07OTKgdhZo+lVgJm7l3dntRT h7MnUbodLCxaE51vpjZsmC1nnt1zBngJPRNKO4Si+tKTTjey6VDUlDh59gXatgTxyeVS 8R+g== X-Gm-Message-State: APt69E0fXyyDT7Y2mhUfA4U3uP/1QZKNXO2zX9c99iZEdbx5rgSoa+gW zUdwMzndnH5XfU+mGIAtR9/zmg== X-Google-Smtp-Source: AAOMgpf1PlIsL1m0A/fvUX9trU9yH1HjCqDVrr3Ss53bJ6dhkRQ+uHZWMmeaXfnNSz7pkNJ10OByXQ== X-Received: by 2002:adf:cc8e:: with SMTP id p14-v6mr1686645wrj.226.1529677323441; Fri, 22 Jun 2018 07:22:03 -0700 (PDT) Received: from lpoulain-ThinkPad-T470p.home (LFbn-1-2080-109.w90-76.abo.wanadoo.fr. [90.76.145.109]) by smtp.gmail.com with ESMTPSA id r75-v6sm4179120wmg.31.2018.06.22.07.22.02 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 22 Jun 2018 07:22:02 -0700 (PDT) From: Loic Poulain To: johan@kernel.org Cc: linux-usb@vger.kernel.org, srinivas.kandagatla@linaro.org, ajaykuee@gmail.com, Loic Poulain Subject: [PATCH v3] USB: serial: ftdi_sio: Add MTP NVM support Date: Fri, 22 Jun 2018 16:22:01 +0200 Message-Id: <1529677321-2341-1-git-send-email-loic.poulain@linaro.org> X-Mailer: git-send-email 2.7.4 Sender: linux-usb-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-usb@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Most of FTDI's devices have an EEPROM which records FTDI devices configuration setting (e.g. the VID, PID, I/O config...) and user data. FT230R chip integrates a 128-byte eeprom, FT230X a 2048-byte eeprom... This patch adds support for FTDI EEPROM read/write via USB control transfers and register a new nvm device to the nvmem core. This permits to expose the eeprom as a sysfs file, allowing userspace to read/modify FTDI configuration and its user data without having to rely on a specific userspace USB driver. Moreover, any upcoming new tentative to add CBUS GPIO support could integrate CBUS EEPROM configuration reading in order to determine which of the CBUS pins are available as GPIO. Signed-off-by: Loic Poulain --- v2: Use ifdef instead of IS_ENABLED error message in case of nvmem registering failure Fix space/tab in Kconfig v3: Make nvmem a child of the usb dev instead of the serial port Add macros defining eeprom sizes Check read/write size is a nultiple of the eeprom word-size Remove useless change in Kconfig drivers/usb/serial/Kconfig | 11 ++++ drivers/usb/serial/ftdi_sio.c | 123 ++++++++++++++++++++++++++++++++++++++++++ drivers/usb/serial/ftdi_sio.h | 28 ++++++++++ 3 files changed, 162 insertions(+) diff --git a/drivers/usb/serial/Kconfig b/drivers/usb/serial/Kconfig index 533f127..ee9230c 100644 --- a/drivers/usb/serial/Kconfig +++ b/drivers/usb/serial/Kconfig @@ -181,6 +181,17 @@ config USB_SERIAL_FTDI_SIO To compile this driver as a module, choose M here: the module will be called ftdi_sio. +config USB_SERIAL_FTDI_SIO_NVMEM + bool "FTDI MTP non-volatile memory support" + depends on USB_SERIAL_FTDI_SIO + select NVMEM + default y + help + Say yes here to add support for the MTP non-volatile memory + present on FTDI. Most of FTDI's devices have an EEPROM which + records FTDI device's configuration setting as well as user + data. + config USB_SERIAL_VISOR tristate "USB Handspring Visor / Palm m50x / Sony Clie Driver" help diff --git a/drivers/usb/serial/ftdi_sio.c b/drivers/usb/serial/ftdi_sio.c index 7ea221d..8183b02 100644 --- a/drivers/usb/serial/ftdi_sio.c +++ b/drivers/usb/serial/ftdi_sio.c @@ -40,6 +40,7 @@ #include #include #include +#include #include "ftdi_sio.h" #include "ftdi_sio_ids.h" @@ -73,6 +74,8 @@ struct ftdi_private { unsigned int latency; /* latency setting in use */ unsigned short max_packet_size; struct mutex cfg_lock; /* Avoid mess by parallel calls of config ioctl() and change_speed() */ + + struct nvmem_device *eeprom; }; /* struct ftdi_sio_quirk is used by devices requiring special attention. */ @@ -1529,6 +1532,116 @@ static int get_lsr_info(struct usb_serial_port *port, return 0; } +#ifdef CONFIG_USB_SERIAL_FTDI_SIO_NVMEM + +#define EEPROM_SZ_FTX 2048 /* cf FTDI AN_201 */ +#define EEPROM_SZ_FT232RL 128 /* cf FTDI AN_121 */ + +static int write_eeprom(void *priv, unsigned int off, void *_val, size_t bytes) +{ + struct usb_serial_port *port = priv; + struct usb_serial *serial = port->serial; + struct usb_device *udev = serial->dev; + unsigned char *buf = _val; + + if (bytes % 2) /* 16-bit eeprom */ + return -EINVAL; + + while (bytes) { + uint16_t val; + int rv; + + val = buf[0] + (buf[1] << 8); + + rv = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), + FTDI_SIO_WRITE_EEPROM_REQUEST, + FTDI_SIO_WRITE_EEPROM_REQUEST_TYPE, + val, off / 2, NULL, 0, WDR_TIMEOUT); + if (rv < 0) + return rv; + + off += 2; + buf += 2; + bytes -= 2; + } + + return 0; +} + +static int read_eeprom(void *priv, unsigned int off, void *val, size_t bytes) +{ + struct usb_serial_port *port = priv; + struct usb_serial *serial = port->serial; + struct usb_device *udev = serial->dev; + unsigned char *buf = val; + + if (bytes % 2) /* 16-bit eeprom */ + return -EINVAL; + + while (bytes) { + int rv; + + rv = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0), + FTDI_SIO_READ_EEPROM_REQUEST, + FTDI_SIO_READ_EEPROM_REQUEST_TYPE, + 0, off / 2, buf, 2, WDR_TIMEOUT); + if (rv < 0) + return rv; + + off += 2; + buf += 2; + bytes -= 2; + } + + return 0; +} + +static int register_eeprom(struct usb_serial_port *port) +{ + struct ftdi_private *priv = usb_get_serial_port_data(port); + struct usb_device *udev = port->serial->dev; + struct nvmem_config nvmconf = {}; + + switch (priv->chip_type) { + case FTX: + nvmconf.size = EEPROM_SZ_FTX; + break; + case FT232RL: + nvmconf.size = EEPROM_SZ_FT232RL; + break; + default: + return 0; + } + + nvmconf.word_size = 2; + nvmconf.stride = 2; + nvmconf.read_only = false; + nvmconf.priv = port; + nvmconf.dev = &udev->dev; + nvmconf.reg_read = read_eeprom; + nvmconf.reg_write = write_eeprom; + nvmconf.owner = THIS_MODULE; + + priv->eeprom = nvmem_register(&nvmconf); + if (IS_ERR(priv->eeprom)) { + priv->eeprom = NULL; + return -ENOMEM; + } + + dev_info(&udev->dev, "Registered %d-byte FTDI EEPROM\n", nvmconf.size); + + return 0; +} + +static void unregister_eeprom(struct usb_serial_port *port) +{ + struct ftdi_private *priv = usb_get_serial_port_data(port); + + if (priv->eeprom) + nvmem_unregister(priv->eeprom); +} + +#endif /* CONFIG_USB_SERIAL_FTDI_SIO_NVMEM */ /* Determine type of FTDI chip based on USB config and descriptor. */ static void ftdi_determine_type(struct usb_serial_port *port) @@ -1814,6 +1927,13 @@ static int ftdi_sio_port_probe(struct usb_serial_port *port) priv->latency = 16; write_latency_timer(port); create_sysfs_attrs(port); +#ifdef CONFIG_USB_SERIAL_FTDI_SIO_NVMEM + if (register_eeprom(port)) { + dev_err(&port->dev, "Unable to register FTDI EEPROM\n"); + /* non-fatal */ + } +#endif + return 0; } @@ -1931,6 +2051,9 @@ static int ftdi_sio_port_remove(struct usb_serial_port *port) { struct ftdi_private *priv = usb_get_serial_port_data(port); +#ifdef CONFIG_USB_SERIAL_FTDI_SIO_NVMEM + unregister_eeprom(port); +#endif remove_sysfs_attrs(port); kfree(priv); diff --git a/drivers/usb/serial/ftdi_sio.h b/drivers/usb/serial/ftdi_sio.h index dcd0b6e..9eab961 100644 --- a/drivers/usb/serial/ftdi_sio.h +++ b/drivers/usb/serial/ftdi_sio.h @@ -36,6 +36,8 @@ #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */ #define FTDI_SIO_SET_LATENCY_TIMER 9 /* Set the latency timer */ #define FTDI_SIO_GET_LATENCY_TIMER 10 /* Get the latency timer */ +#define FTDI_SIO_READ_EEPROM 0x90 /* Read eeprom */ +#define FTDI_SIO_WRITE_EEPROM 0x91 /* Write eeprom */ /* Interface indices for FT2232, FT2232H and FT4232H devices */ #define INTERFACE_A 1 @@ -400,6 +402,32 @@ enum ftdi_sio_baudrate { * */ + /* FTDI_SIO_READ_EEPROM */ +#define FTDI_SIO_READ_EEPROM_REQUEST_TYPE 0xc0 +#define FTDI_SIO_READ_EEPROM_REQUEST FTDI_SIO_READ_EEPROM +/* + * BmRequestType: 1100 0000b + * bRequest: FTDI_SIO_READ_EEPROM + * wValue: 0 + * wIndex: Word Index + * wLength: 2 + * Data: return data (a word) + * + */ + +/* FTDI_SIO_WRITE_EEPROM */ +#define FTDI_SIO_WRITE_EEPROM_REQUEST_TYPE 0x40 +#define FTDI_SIO_WRITE_EEPROM_REQUEST FTDI_SIO_WRITE_EEPROM +/* + * BmRequestType: 0100 0000b + * bRequest: FTDI_SIO_WRITE_EEPROM + * wValue: Data (word) + * wIndex: Word Index + * wLength: 0 + * Data: None + * + */ + /* FTDI_SIO_GET_MODEM_STATUS */ /* Retrieve the current value of the modem status register */