From patchwork Tue Nov 3 08:47:40 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AceLan Kao X-Patchwork-Id: 1392717 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=none (no SPF record) smtp.mailfrom=lists.ubuntu.com (client-ip=91.189.94.19; helo=huckleberry.canonical.com; envelope-from=kernel-team-bounces@lists.ubuntu.com; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=canonical.com Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20161025 header.b=OFG3ygOH; dkim-atps=neutral Received: from huckleberry.canonical.com (huckleberry.canonical.com [91.189.94.19]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4CQNj20NTGz9sTD; Tue, 3 Nov 2020 19:48:06 +1100 (AEDT) Received: from localhost ([127.0.0.1] helo=huckleberry.canonical.com) by huckleberry.canonical.com with esmtp (Exim 4.86_2) (envelope-from ) id 1kZrz0-0004Vk-JB; Tue, 03 Nov 2020 08:48:02 +0000 Received: from mail-pg1-f194.google.com ([209.85.215.194]) by huckleberry.canonical.com with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.86_2) (envelope-from ) id 1kZryu-0004S4-Qe for kernel-team@lists.ubuntu.com; Tue, 03 Nov 2020 08:47:57 +0000 Received: by mail-pg1-f194.google.com with SMTP id f38so13155451pgm.2 for ; Tue, 03 Nov 2020 00:47:56 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=BJar2FiQiSBog9yhc4i+H9dzZjCC52mUBTcLGyAfijg=; b=OFG3ygOHP5Mf2cJ6zMyDUymxRJkN6LmVlPRBjpeD9HJ1JhRVczqL3ZdPTN7R9Uy4uD 8Fe59BtGuTYLAZZ9yxnpDo8MgDiLXVdhLk8Nhj6zyhjRgJY6qDc7yAtwBcgO6uymtdVB R+gK8Yq8PFqRuYrfh1kHHzt8e18kexTqiVij2tWNm7nLNRdiHIzzsCRV960HqydL6ir5 zT4DBf4VvjlNaAesi/FZDEipgAaLKQo3fEcGCsN/umrrImrZKsj8GhM8ghbaMlG0lpIF 0DesxwAAft13CTfC4++399QLz50MfZLM/ktGuFvQrZ24KD98cB1adEfOOM/fPUG+5o2D KBnA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=BJar2FiQiSBog9yhc4i+H9dzZjCC52mUBTcLGyAfijg=; b=QgQMnC96Q4VQl8mPqpP3IwaD8mnVSJrGnf3PovGFLAIBEXYKE0rvRIjQWErE7Tc88N yUWVceI9BTKjkEvMXbHVh1sUAeZCbTQRvyTk2ndhpoGhHfgvWTp8tHBglbvY4eJhXEwo h1SegvTiXZbLwYqzniHsgpW7Iwc6AbA1bQa60D8Cg3t887Mj0UTYmtWQh2qV1NOwXBI2 B+sykqS1G4hqZi8H4AnD5M0/KG/C6CHpiNr1RsmgkMneBItuX93ha2FHE5e8yODhXcEe NZ7eeKwz47NJAkgReOWOj3NqxyN/IXHrjoN2VGM0pCdF/1ORjDiGPkobeTyPAPHSgs8x YJ0Q== X-Gm-Message-State: AOAM532QEc9byuUZF3IyaFk0tr3gAGKMn+SmxVlj9q3SF3HtJ5XPh5HQ ndniJJRmF5PsgJrPO5b5Hg2wy7sVIN8= X-Google-Smtp-Source: ABdhPJz3VsMrUpBbwtbFx/NP+u/6YzqZl6fX/l++crWzmmBb0ORIwNebuI9mZSgTmcKLN9VQQgp7uA== X-Received: by 2002:a63:9548:: with SMTP id t8mr8617318pgn.304.1604393273872; Tue, 03 Nov 2020 00:47:53 -0800 (PST) Received: from localhost (61-220-137-37.HINET-IP.hinet.net. [61.220.137.37]) by smtp.gmail.com with ESMTPSA id v3sm2171801pju.38.2020.11.03.00.47.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 03 Nov 2020 00:47:53 -0800 (PST) From: AceLan Kao To: kernel-team@lists.ubuntu.com, "Shihlun . Lin" , "Campion . Kang" Subject: [PATCH 4/6][SRU][F] UBUNTU: SAUCE: mfd: ahc1ec0: Add support for Advantech embedded controller Date: Tue, 3 Nov 2020 16:47:40 +0800 Message-Id: <20201103084742.56740-5-acelan.kao@canonical.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201103084742.56740-1-acelan.kao@canonical.com> References: <20201103084742.56740-1-acelan.kao@canonical.com> MIME-Version: 1.0 Received-SPF: pass client-ip=209.85.215.194; envelope-from=acelan@gmail.com; helo=mail-pg1-f194.google.com X-BeenThere: kernel-team@lists.ubuntu.com X-Mailman-Version: 2.1.20 Precedence: list List-Id: Kernel team discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: kernel-team-bounces@lists.ubuntu.com Sender: "kernel-team" From: Shihlun Lin BugLink: https://bugs.launchpad.net/bugs/1902672 AHC1EC0 is the embedded controller driver for Advantech industrial products. This provides sub-devices such as hwmon and watchdog, and also expose functions for sud-devices to read/write the value to embedded controller. Signed-off-by: Shihlun Lin Reported-by: kernel test robot Signed-off-by: AceLan Kao --- drivers/mfd/Kconfig | 9 + drivers/mfd/Makefile | 2 + drivers/mfd/ahc1ec0.c | 1419 +++++++++++++++++++++++++++++++++++ include/linux/mfd/ahc1ec0.h | 338 +++++++++ 4 files changed, 1768 insertions(+) create mode 100644 drivers/mfd/ahc1ec0.c create mode 100644 include/linux/mfd/ahc1ec0.h diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig index 43169f25da1f..d550ee59ea96 100644 --- a/drivers/mfd/Kconfig +++ b/drivers/mfd/Kconfig @@ -2012,5 +2012,14 @@ config RAVE_SP_CORE Select this to get support for the Supervisory Processor device found on several devices in RAVE line of hardware. +config MFD_AHC1EC0 + tristate "Advantech Embedded Controller Module" + select MFD_CORE + help + This is the core function that for Advantech EC drivers. It + includes the sub-devices such as hwmon, watchdog, etc. And also + provides expose functions for sub-devices to read/write the value + to embedded controller. + endmenu endif diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile index c1067ea46204..59f7638a5812 100644 --- a/drivers/mfd/Makefile +++ b/drivers/mfd/Makefile @@ -256,3 +256,5 @@ obj-$(CONFIG_MFD_ROHM_BD70528) += rohm-bd70528.o obj-$(CONFIG_MFD_ROHM_BD718XX) += rohm-bd718x7.o obj-$(CONFIG_MFD_STMFX) += stmfx.o +obj-$(CONFIG_MFD_AHC1EC0) += ahc1ec0.o + diff --git a/drivers/mfd/ahc1ec0.c b/drivers/mfd/ahc1ec0.c new file mode 100644 index 000000000000..a6cda424d5d3 --- /dev/null +++ b/drivers/mfd/ahc1ec0.c @@ -0,0 +1,1419 @@ +// SPDX-License-Identifier: GPL-2.0-only +/***************************************************************************** + * Copyright (c) 2018, Advantech Automation Corp. + * THIS IS AN UNPUBLISHED WORK CONTAINING CONFIDENTIAL AND PROPRIETARY + * INFORMATION WHICH IS THE PROPERTY OF ADVANTECH AUTOMATION CORP. + * + * ANY DISCLOSURE, USE, OR REPRODUCTION, WITHOUT WRITTEN AUTHORIZATION FROM + * ADVANTECH AUTOMATION CORP., IS STRICTLY PROHIBITED. + ***************************************************************************** + * + * File: ahc1ec0.c + * Version: 1.00 <10/10/2014> + * Author: Sun.Lang + * + * Description: The ahc1ec0 is multifunctional driver for controlling EC chip. + * + * + * Status: working + * + * Change Log: + * Version 1.00 <10/10/2014> Sun.Lang + * - Initial version + * Version 1.01 <11/05/2015> Jiangwei.Zhu + * - Modify read_ad_value() function. + * - Add smbus_read_byte() function. + * - Add smbus_write_byte() function. + * - Add wait_smbus_protocol_finish() function. + * Version 1.02 <03/04/2016> Jiangwei.Zhu + * - Add smbus_read_word() function. + * Version 1.03 <01/22/2017> Ji.Xu + * - Add detect to Advantech porduct name "ECU". + * Version 1.04 <09/20/2017> Ji.Xu + * - Update to support detect Advantech product name in UEFI + * BIOS(DMI). + * Version 1.05 <11/02/2017> Ji.Xu + * - Fixed issue: Cache coherency error when exec 'ioremap_uncache()' + * in kernel-4.10. + * Version 1.06 <10/16/2020> Shihlun.Lin + * - Update: Replace ioremap_nocache() with ioremap_uc() since + * ioremap_uc() was used on the entire PCI BAR. + ******************************************************************************/ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define ADVANTECH_EC_NAME "ahc1ec0" +#define ADVANTECH_EC_MFD_VER "2.0.0" +#define ADVANTECH_EC_MFD_DATE "10/16/2020" + +struct mutex lock; + +enum { + ADVEC_SUBDEV_BRIGHTNESS = 0, + ADVEC_SUBDEV_EEPROM, + ADVEC_SUBDEV_GPIO, + ADVEC_SUBDEV_HWMON, + ADVEC_SUBDEV_LED, + ADVEC_SUBDEV_WDT, + ADVEC_SUBDEV_MAX, +}; + +static int wait_ibf(void) +{ + int i; + + for (i = 0; i < EC_MAX_TIMEOUT_COUNT; i++) { + if ((inb(EC_COMMAND_PORT) & 0x02) == 0) + return 0; + + udelay(EC_UDELAY_TIME); + } + + return -ETIMEDOUT; +} + +/* Wait OBF (Output buffer full) set */ +static int wait_obf(void) +{ + int i; + + for (i = 0; i < EC_MAX_TIMEOUT_COUNT; i++) { + if ((inb(EC_COMMAND_PORT) & 0x01) != 0) + return 0; + + udelay(EC_UDELAY_TIME); + } + + return -ETIMEDOUT; +} + +/* Read data from EC HW ram */ +static int read_hw_ram(uchar addr, uchar *data) +{ + int ret; + + mutex_lock(&lock); + + /* Step 0. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 1. Send "read EC HW ram" command to EC Command port */ + outb(EC_HW_RAM_READ, EC_COMMAND_PORT); + + /* Step 2. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 3. Send "EC HW ram" address to EC Data port */ + outb(addr, EC_STATUS_PORT); + + /* Step 4. Wait OBF set */ + ret = wait_obf(); + if (ret) + goto error; + + /* Step 5. Get "EC HW ram" data from EC Data port */ + *data = inb(EC_STATUS_PORT); + + mutex_unlock(&lock); + + return ret; + +error: + mutex_unlock(&lock); + pr_err("%s: Wait for IBF or OBF too long. line: %d", __func__, __LINE__); + return ret; +} + +/* Write data to EC HW ram */ +int write_hw_ram(uchar addr, uchar data) +{ + int ret; + + mutex_lock(&lock); + /* Step 0. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 1. Send "write EC HW ram" command to EC command port */ + outb(EC_HW_RAM_WRITE, EC_COMMAND_PORT); + + /* Step 2. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 3. Send "EC HW ram" address to EC Data port */ + outb(addr, EC_STATUS_PORT); + + /* Step 4. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 5. Send "EC HW ram" data to EC Data port */ + outb(data, EC_STATUS_PORT); + + mutex_unlock(&lock); + + return 0; + +error: + mutex_unlock(&lock); + pr_err("%s: Wait for IBF too long. line: %d", __func__, __LINE__); + return ret; +} +EXPORT_SYMBOL_GPL(write_hw_ram); + +static int wait_smbus_protocol_finish(void) +{ + uchar addr, data; + int retry = 1000; + + do { + addr = EC_SMBUS_PROTOCOL; + data = 0xFF; + if (!read_hw_ram(addr, &data)) + return 0; + + if (data == 0) + return 0; + + udelay(EC_UDELAY_TIME); + } while (retry-- > 0); + + return -ETIMEDOUT; +} + +/* Get dynamic control table */ +static int adv_get_dynamic_tab(struct adv_ec_platform_data *pdata) +{ + int i, ret; + uchar pin_tmp, device_id; + + mutex_lock(&lock); + + for (i = 0; i < EC_MAX_TBL_NUM; i++) { + pdata->dym_tbl[i].DeviceID = 0xff; + pdata->dym_tbl[i].HWPinNumber = 0xff; + } + + for (i = 0; i < EC_MAX_TBL_NUM; i++) { + /* Step 0. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* + * Step 1. Write 0x20 to 0x29A + * Send write item number into index command + */ + outb(EC_TBL_WRITE_ITEM, EC_COMMAND_PORT); + + /* Step 2. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* + * Step 3. Write item number to 0x299 + * Write item number to index. Item number is limited in range 0 to 31 + */ + outb(i, EC_STATUS_PORT); + + /* Step 4. Wait OBF set */ + ret = wait_obf(); + if (ret) + goto error; + + /* + * Step 5. Read 0x299 port + * If item is defined, EC will return item number. + * If table item is not defined, EC will return 0xFF. + */ + if (inb(EC_STATUS_PORT) == 0xff) { + mutex_unlock(&lock); + return -EINVAL; + } + + /* Step 6. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* + * Step 7. Write 0x21 to 0x29A + * Send read HW pin number command + */ + outb(EC_TBL_GET_PIN, EC_COMMAND_PORT); + + /* Step 8. Wait OBF set */ + ret = wait_obf(); + if (ret) + goto error; + + /* + * Step 9. Read 0x299 port + * EC will return current item HW pin number + */ + pin_tmp = inb(EC_STATUS_PORT) & 0xff; + + /* Step 10. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + if (pin_tmp == 0xff) { + mutex_unlock(&lock); + return -EINVAL; + } + + /* + * Step 11. Write 0x22 to 0x29A + * Send read device id command + */ + outb(EC_TBL_GET_DEVID, EC_COMMAND_PORT); + + /* Step 12. Wait OBF set */ + ret = wait_obf(); + if (ret) + goto error; + + /* + * Step 13. Read 0x299 port + * EC will return current item Device ID + */ + device_id = inb(EC_STATUS_PORT) & 0xff; + + /* Step 14. Save data to a database */ + pdata->dym_tbl[i].DeviceID = device_id; + pdata->dym_tbl[i].HWPinNumber = pin_tmp; + } + + mutex_unlock(&lock); + return 0; + +error: + mutex_unlock(&lock); + pr_err("%s: Wait for IBF or OBF too long. line: %d", __func__, __LINE__); + return ret; +} + +int read_ad_value(uchar hwpin, uchar multi) +{ + int ret; + u32 ret_val; + uchar LSB, MSB; + + mutex_lock(&lock); + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_AD_INDEX_WRITE, EC_COMMAND_PORT); + ret = wait_ibf(); + if (ret) + goto error; + + outb(hwpin, EC_STATUS_PORT); + ret = wait_obf(); + if (ret) + goto error; + + if (inb(EC_STATUS_PORT) == 0xff) { + mutex_unlock(&lock); + return -1; + } + + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_AD_LSB_READ, EC_COMMAND_PORT); + ret = wait_obf(); + if (ret) + goto error; + + LSB = inb(EC_STATUS_PORT); + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_AD_MSB_READ, EC_COMMAND_PORT); + ret = wait_obf(); + if (ret) + goto error; + + MSB = inb(EC_STATUS_PORT); + ret_val = ((MSB << 8) | LSB) & 0x03FF; + ret_val = ret_val * multi * 100; + + mutex_unlock(&lock); + return ret_val; + +error: + mutex_unlock(&lock); + pr_warn("%s: Wait for IBF or OBF too long. line: %d", __func__, __LINE__); + return ret; +} +EXPORT_SYMBOL_GPL(read_ad_value); + +int read_acpi_value(uchar addr, uchar *pvalue) +{ + int ret; + uchar value; + + mutex_lock(&lock); + + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_ACPI_RAM_READ, EC_COMMAND_PORT); + ret = wait_ibf(); + if (ret) + goto error; + + outb(addr, EC_STATUS_PORT); + ret = wait_obf(); + if (ret) + goto error; + + value = inb(EC_STATUS_PORT); + *pvalue = value; + mutex_unlock(&lock); + + return 0; + +error: + mutex_unlock(&lock); + pr_warn("%s: Wait for IBF or OBF too long. line: %d", __func__, __LINE__); + return ret; +} +EXPORT_SYMBOL_GPL(read_acpi_value); + +int write_acpi_value(uchar addr, uchar value) +{ + int ret; + + mutex_lock(&lock); + + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_ACPI_DATA_WRITE, EC_COMMAND_PORT); + + ret = wait_ibf(); + if (ret) + goto error; + + outb(addr, EC_STATUS_PORT); + + ret = wait_ibf(); + if (ret) + goto error; + + outb(value, EC_STATUS_PORT); + + mutex_unlock(&lock); + return 0; + +error: + mutex_unlock(&lock); + pr_warn("%s: Wait for IBF too long. line: %d", __func__, __LINE__); + return ret; +} + +int read_gpio_status(uchar PinNumber, uchar *pvalue) +{ + int ret; + + uchar gpio_status_value; + + mutex_lock(&lock); + + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_GPIO_INDEX_WRITE, EC_COMMAND_PORT); + + ret = wait_ibf(); + if (ret) + goto error; + + outb(PinNumber, EC_STATUS_PORT); + + ret = wait_obf(); + if (ret) + goto error; + + if (inb(EC_STATUS_PORT) == 0xff) { + pr_err("%s: Read Pin Number error!!", __func__); + mutex_unlock(&lock); + return -1; + } + + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_GPIO_STATUS_READ, EC_COMMAND_PORT); + + ret = wait_obf(); + if (ret) + goto error; + + gpio_status_value = inb(EC_STATUS_PORT); + *pvalue = gpio_status_value; + mutex_unlock(&lock); + return 0; + +error: + mutex_unlock(&lock); + pr_warn("%s: Wait for IBF or OBF too long. line: %d", __func__, __LINE__); + return ret; +} + +int write_gpio_status(uchar PinNumber, uchar value) +{ + int ret; + + mutex_lock(&lock); + + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_GPIO_INDEX_WRITE, EC_COMMAND_PORT); + ret = wait_ibf(); + if (ret) + goto error; + + outb(PinNumber, EC_STATUS_PORT); + ret = wait_obf(); + if (ret) + goto error; + + if (inb(EC_STATUS_PORT) == 0xff) { + pr_err("%s: Read Pin Number error!!", __func__); + mutex_unlock(&lock); + return -1; + } + + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_GPIO_STATUS_WRITE, EC_COMMAND_PORT); + ret = wait_ibf(); + if (ret) + goto error; + + outb(value, EC_STATUS_PORT); + mutex_unlock(&lock); + return 0; + +error: + mutex_unlock(&lock); + pr_warn("%s: Wait for IBF or OBF too long. line: %d", __func__, __LINE__); + return ret; +} + +int read_gpio_dir(uchar PinNumber, uchar *pvalue) +{ + int ret; + uchar gpio_dir_value; + + mutex_lock(&lock); + + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_GPIO_INDEX_WRITE, EC_COMMAND_PORT); + ret = wait_ibf(); + if (ret) + goto error; + + outb(PinNumber, EC_STATUS_PORT); + ret = wait_obf(); + if (ret) + goto error; + + if (inb(EC_STATUS_PORT) == 0xff) { + pr_err("%s: Read Pin Number error!!", __func__); + mutex_unlock(&lock); + return -1; + } + + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_GPIO_DIR_READ, EC_COMMAND_PORT); + ret = wait_obf(); + if (ret) + goto error; + + gpio_dir_value = inb(EC_STATUS_PORT); + *pvalue = gpio_dir_value; + mutex_unlock(&lock); + return 0; + +error: + mutex_unlock(&lock); + pr_warn("%s: Wait for IBF or OBF too long. line: %d", __func__, __LINE__); + return ret; +} + +int write_gpio_dir(uchar PinNumber, uchar value) +{ + int ret; + + mutex_lock(&lock); + + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_GPIO_INDEX_WRITE, EC_COMMAND_PORT); + ret = wait_ibf(); + if (ret) + goto error; + + outb(PinNumber, EC_STATUS_PORT); + ret = wait_obf(); + if (ret) + goto error; + + if (inb(EC_STATUS_PORT) == 0xff) { + pr_err("%s: Read Pin Number error!!", __func__); + mutex_unlock(&lock); + return -1; + } + + ret = wait_ibf(); + if (ret) + goto error; + + outb(EC_GPIO_DIR_WRITE, EC_COMMAND_PORT); + ret = wait_ibf(); + if (ret) + goto error; + + outb(value, EC_STATUS_PORT); + mutex_unlock(&lock); + return 0; + +error: + mutex_unlock(&lock); + pr_warn("%s: Wait for IBF or OBF too long. line: %d", __func__, __LINE__); + return ret; +} + +/* Write data to EC HW ram */ +int write_hw_extend_ram(uchar addr, uchar data) +{ + int ret; + + mutex_lock(&lock); + /* Step 0. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 1. Send "write EC HW ram" command to EC command port */ + outb(EC_HW_EXTEND_RAM_WRITE, EC_COMMAND_PORT); + + /* Step 2. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 3. Send "EC HW ram" address to EC Data port */ + outb(addr, EC_STATUS_PORT); + + /* Step 4. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 5. Send "EC HW ram" data to EC Data port */ + outb(data, EC_STATUS_PORT); + + mutex_unlock(&lock); + + return 0; + +error: + mutex_unlock(&lock); + pr_debug("%s: Wait for IBF too long. line: %d", __func__, __LINE__); + return ret; +} + +int write_hwram_command(uchar data) +{ + int ret; + + mutex_lock(&lock); + + ret = wait_ibf(); + if (ret) + goto error; + + outb(data, EC_COMMAND_PORT); + mutex_unlock(&lock); + return 0; + +error: + mutex_unlock(&lock); + pr_debug("%s: Wait for IBF too long. line: %d", __func__, __LINE__); + return ret; +} +EXPORT_SYMBOL_GPL(write_hwram_command); + +int smbus_read_word(struct EC_SMBUS_WORD_DATA *ptr_ec_smbus_word_data) +{ + int ret; + + uchar sm_ready, LSB, MSB, addr, data; + unsigned short Value = 0; + + /* Step 1. Select SMBus channel */ + addr = EC_SMBUS_CHANNEL; + data = ptr_ec_smbus_word_data->Channel; + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Select SMBus channel Failed"); + goto error; + } + + /* Step 2. Set SMBUS device address EX: 0x98 */ + addr = EC_SMBUS_SLV_ADDR; + data = (ptr_ec_smbus_word_data->Address); + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Select SMBus dev addr:0x%02X Failed", ptr_ec_smbus_word_data->Address); + goto error; + } + + /* Step 3. Set Chip (EX: INA266) Register Address */ + addr = EC_SMBUS_CMD; + data = ptr_ec_smbus_word_data->Register; + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Select Chip Register Addr:0x%02X Failed", ptr_ec_smbus_word_data->Register); + goto error; + } + + /* Step 4. Set EC SMBUS read word Mode */ + addr = EC_SMBUS_PROTOCOL; + data = SMBUS_WORD_READ; + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Set EC SMBUS read Byte Mode Failed"); + goto error; + } + + /* Step 5. Check EC Smbus states */ + ret = wait_smbus_protocol_finish(); + if (ret) { + pr_err("Wait SmBus Protocol Finish Failed!!"); + goto error; + } + + addr = EC_SMBUS_STATUS; + ret = read_hw_ram(addr, &data); + if (ret) { + pr_err("Check EC Smbus states Failed"); + goto error; + } + sm_ready = data; + + /* check no error */ + if (sm_ready != 0x80) { + pr_err("SMBUS ERR:0x%02X", sm_ready); + goto error; + } + + /* Step 6. Get Value */ + addr = EC_SMBUS_DAT_OFFSET(0); + ret = read_hw_ram(addr, &data); + if (ret) { + pr_err("Get Value Failed"); + goto error; + } + MSB = data; + + addr = EC_SMBUS_DAT_OFFSET(1); + ret = read_hw_ram(addr, &data); + if (ret) { + pr_err("Get Value Failed"); + goto error; + } + LSB = data; + + Value = (MSB << 8) | LSB; + ptr_ec_smbus_word_data->Value = Value; + + return 0; + +error: + pr_err("%s: Exception!", __func__); + return ret; +} +EXPORT_SYMBOL_GPL(smbus_read_word); + +int smbus_read_byte(struct EC_SMBUS_READ_BYTE *ptr_ec_smbus_read_byte) +{ + int ret; + uchar sm_ready, addr, data; + + /* CHECK_PARAMETER */ + if (ptr_ec_smbus_read_byte == NULL) + return -EINVAL; + + /* Step 1. Select SMBus channel */ + addr = EC_SMBUS_CHANNEL; + data = ptr_ec_smbus_read_byte->Channel; + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Select SMBus channel Failed"); + goto error; + } + + /* Step 2. Set SMBUS device address EX: 0x98 */ + addr = EC_SMBUS_SLV_ADDR; + data = (ptr_ec_smbus_read_byte->Address); + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Select SMBus dev addr:0x%02X Failed", ptr_ec_smbus_read_byte->Address); + goto error; + } + + /* Step 3. Set Chip (EX: MCP23008) Register Address */ + addr = EC_SMBUS_CMD; + data = ptr_ec_smbus_read_byte->Register; + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Select Chip Register Addr:0x%02X Failed", ptr_ec_smbus_read_byte->Register); + goto error; + } + + /* Step 4. Set EC SMBUS read Byte Mode */ + addr = EC_SMBUS_PROTOCOL; + data = SMBUS_BYTE_READ; + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Set EC SMBUS read Byte Mode Failed"); + goto error; + } + + /* Step 5. Check EC Smbus states */ + ret = wait_smbus_protocol_finish(); + if (ret) { + pr_err("Wait SmBus Protocol Finish Failed!!"); + goto error; + } + + addr = EC_SMBUS_STATUS; + ret = read_hw_ram(addr, &data); + if (ret) { + pr_err("Check EC Smbus states Failed"); + goto error; + } + sm_ready = data; + + /* check no error */ + if (sm_ready != 0x80) { + pr_err("SMBUS ERR:(0x%02X)", sm_ready); + goto error; + } + + /* Step 6. Get Value */ + addr = EC_SMBUS_DATA; + ret = read_hw_ram(addr, &data); + if (ret) { + pr_err("Get Value Failed"); + goto error; + } + + ptr_ec_smbus_read_byte->Data = (data & 0xFF); + return 0; + +error: + pr_err("%s: Exception!", __func__); + return ret; +} +EXPORT_SYMBOL_GPL(smbus_read_byte); + +int smbus_write_byte(struct EC_SMBUS_WRITE_BYTE *ptr_ec_smbus_write_byte) +{ + int ret; + uchar sm_ready, addr, data; + + /* Step 1. Select SMBus channel */ + addr = EC_SMBUS_CHANNEL; + data = ptr_ec_smbus_write_byte->Channel; + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Select SMBus channel Failed"); + goto error; + } + + /* Step 2. Set SMBUS device address EX: 0x98 */ + addr = EC_SMBUS_SLV_ADDR; + data = (ptr_ec_smbus_write_byte->Address); + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Select SMBus dev addr:0x%02X Failed", ptr_ec_smbus_write_byte->Address); + goto error; + } + + /* Step 3. Set Chip (EX: MCP23008) Register Address */ + addr = EC_SMBUS_CMD; + data = ptr_ec_smbus_write_byte->Register; + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Select Chip reg addr:0x%02X Failed", ptr_ec_smbus_write_byte->Register); + goto error; + } + + /* Step 4. Set Data to SMBUS */ + addr = EC_SMBUS_DATA; + data = ptr_ec_smbus_write_byte->Data; + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Set Data 0x%02X to SMBUS Failed", ptr_ec_smbus_write_byte->Data); + goto error; + } + + /* Step 5. Set EC SMBUS write Byte Mode */ + addr = EC_SMBUS_PROTOCOL; + data = SMBUS_BYTE_WRITE; + ret = write_hw_ram(addr, data); + if (ret) { + pr_err("Set EC SMBUS write Byte Mode Failed"); + goto error; + } + + /* Step 6. Check EC Smbus states */ + ret = wait_smbus_protocol_finish(); + if (ret) { + pr_err("Wait SmBus Protocol Finish Failed!!"); + goto error; + } + + addr = EC_SMBUS_STATUS; + ret = read_hw_ram(addr, &data); + if (ret) { + pr_err("Check EC Smbus states Failed"); + goto error; + } + sm_ready = data; + + /* check no error */ + if (sm_ready != 0x80) { + pr_err("SMBUS ERR:(0x%02X)", sm_ready); + goto error; + } + mutex_unlock(&lock); + return 0; + +error: + pr_err("%s: Exception!", __func__); + mutex_unlock(&lock); + return ret; +} + +/* Get One Key Recovery status */ +int read_onekey_status(uchar addr, uchar *pdata) +{ + int ret; + + mutex_lock(&lock); + + /* Init return value */ + *pdata = 0; + + /* Step 0. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 1. Send "One Key Recovery" command to EC Command port */ + outb(EC_ONE_KEY_FLAG, EC_COMMAND_PORT); + + /* Step 2. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 3. Send "One Key Recovery function" address to EC Data port */ + outb(addr, EC_STATUS_PORT); + + /* Step 4. Wait OBF set */ + ret = wait_obf(); + if (ret) + goto error; + + /* Step 5. Get "One Key Recovery function" data from EC Data port */ + *pdata = inb(EC_STATUS_PORT); + + pr_debug("%s: data= %d, line: %d", __func__, *pdata, __LINE__); + mutex_unlock(&lock); + return 0; + +error: + mutex_unlock(&lock); + pr_warn("%s: Wait for IBF or OBF too long. line: %d", __func__, __LINE__); + return ret; +} + +/* Set One Key Recovery status */ +int write_onekey_status(uchar addr) +{ + int ret; + + mutex_lock(&lock); + + /* Step 0. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 1. Send "One Key Recovery" command to EC Command port */ + outb(EC_ONE_KEY_FLAG, EC_COMMAND_PORT); + + /* Step 2. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 3. Send "One Key Recovery function" address to EC Data port */ + outb(addr, EC_STATUS_PORT); + + mutex_unlock(&lock); + + pr_debug("%s: addr= %d, line: %d", __func__, addr, __LINE__); + return 0; + +error: + mutex_unlock(&lock); + pr_debug("%s: Wait for IBF too long. line: %d", __func__, __LINE__); + return ret; +} + +/* EC OEM get status */ +int ec_oem_get_status(uchar addr, uchar *pdata) +{ + int ret; + + mutex_lock(&lock); + + /* Init return value */ + *pdata = 0; + + /* Step 0. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 1. Send "ASG OEM" command to EC Command port */ + outb(EC_ASG_OEM, EC_COMMAND_PORT); + + /* Step 2. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 3. Send "ASG OEM STATUS READ" address to EC Data port */ + outb(EC_ASG_OEM_READ, EC_STATUS_PORT); + + /* Step 4. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 5. Send "OEM STATUS" address to EC Data port */ + outb(addr, EC_STATUS_PORT); + + /* Step 6. Wait OBF set */ + ret = wait_obf(); + if (ret) + goto error; + + /* Step 7. Get "OEM STATUS" data from EC Data port */ + *pdata = inb(EC_STATUS_PORT); + + pr_debug("%s: data= %d, line: %d", __func__, *pdata, __LINE__); + mutex_unlock(&lock); + return 0; + +error: + mutex_unlock(&lock); + pr_warn("%s: Wait for IBF or OBF too long. line: %d", __func__, __LINE__); + return ret; +} + +/* EC OEM set status */ +int ec_oem_set_status(uchar addr, uchar pdata) +{ + int ret; + + mutex_lock(&lock); + + /* Step 0. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 1. Send "ASG OEM" command to EC Command port */ + outb(EC_ASG_OEM, EC_COMMAND_PORT); + + /* Step 2. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 3. Send "ASG OEM STATUS WRITE" address to EC Data port */ + outb(EC_ASG_OEM_WRITE, EC_STATUS_PORT); + + /* Step 4. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 5. Send "OEM STATUS" address to EC Data port */ + outb(addr, EC_STATUS_PORT); + + /* Step 6. Wait IBF clear */ + ret = wait_ibf(); + if (ret) + goto error; + + /* Step 7. Send "OEM STATUS" status to EC Data port */ + outb(pdata, EC_STATUS_PORT); + + pr_debug("%s: data= %d, line: %d", __func__, pdata, __LINE__); + mutex_unlock(&lock); + return 0; + +error: + mutex_unlock(&lock); + pr_warn("%s: Wait for IBF or OBF too long. line: %d", __func__, __LINE__); + + return ret; +} + +static int adv_ec_get_productname(char *product) +{ + static unsigned char *uc_ptaddr; + static unsigned char *uc_epsaddr; + int index = 0, eps_table; + int i = 0; + int length = 0; + int type0_str = 0; + int type1_str = 0; + int is_advantech = 0; + + uc_ptaddr = ioremap(AMI_UEFI_ADVANTECH_BOARD_NAME_ADDRESS, + AMI_UEFI_ADVANTECH_BOARD_NAME_LENGTH); + if (!uc_ptaddr) { + pr_err("Error: ioremap_uc()"); + return -ENXIO; + } + + /* Try to Read the product name from UEFI BIOS(DMI) EPS table */ + for (index = 0; index < AMI_UEFI_ADVANTECH_BOARD_NAME_LENGTH; index++) { + if (uc_ptaddr[index] == '_' + && uc_ptaddr[index+0x1] == 'S' + && uc_ptaddr[index+0x2] == 'M' + && uc_ptaddr[index+0x3] == '_' + && uc_ptaddr[index+0x10] == '_' + && uc_ptaddr[index+0x11] == 'D' + && uc_ptaddr[index+0x12] == 'M' + && uc_ptaddr[index+0x13] == 'I' + && uc_ptaddr[index+0x14] == '_' + ) { + eps_table = 1; + break; + } + } + + /* If EPS table exist, read type1(system information) */ + if (eps_table) { + uc_epsaddr = + (char *)ioremap(((unsigned int *)&uc_ptaddr[index+0x18])[0], + ((unsigned short *)&uc_ptaddr[index+0x16])[0]); + if (!uc_epsaddr) { + uc_epsaddr = + (char *)ioremap_uc(((unsigned int *)&uc_ptaddr[index+0x18])[0], + ((unsigned short *)&uc_ptaddr[index+0x16])[0]); + if (!uc_epsaddr) { + pr_err("Error: both ioremap() and ioremap_uc() exec failed!"); + return -ENXIO; + } + } + + type0_str = (int)uc_epsaddr[1]; + for (i = type0_str; i < (type0_str+512); i++) { + if (uc_epsaddr[i] == 0 && uc_epsaddr[i+1] == 0 && uc_epsaddr[i+2] == 1) { + type1_str = i + uc_epsaddr[i+3]; + break; + } + } + for (i = type1_str; i < (type1_str+512); i++) { + if (!strncmp(&uc_epsaddr[i], "Advantech", 9)) + is_advantech = 1; + + if (uc_epsaddr[i] == 0) { + i++; + type1_str = i; + break; + } + } + length = 2; + while ((uc_epsaddr[type1_str + length] != 0) + && (length < AMI_UEFI_ADVANTECH_BOARD_NAME_LENGTH)) { + length += 1; + } + memmove(product, &uc_epsaddr[type1_str], length); + iounmap((void *)uc_epsaddr); + if (is_advantech) { + iounmap((void *)uc_ptaddr); + return 0; + } + } + + /* It is an old BIOS, read from 0x000F0000 */ + for (index = 0; index < (AMI_UEFI_ADVANTECH_BOARD_NAME_LENGTH - 3); index++) { + if (!strncmp(&uc_ptaddr[index], "TPC", 3) + || !strncmp(&uc_ptaddr[index], "UNO", 3) + || !strncmp(&uc_ptaddr[index], "ITA", 3) + || !strncmp(&uc_ptaddr[index], "MIO", 3) + || !strncmp(&uc_ptaddr[index], "ECU", 3) + || !strncmp(&uc_ptaddr[index], "APAX", 4)) + break; + } + + if (index == (AMI_UEFI_ADVANTECH_BOARD_NAME_LENGTH - 3)) { + pr_err("%s: Can't find the product name, line: %d", __func__, __LINE__); + product[0] = '\0'; + iounmap((void *)uc_ptaddr); + return -ENODATA; + } + + /* Use char "Space" (ASCII code: 32) to check the end of the Product Name. */ + for (i = 0; (uc_ptaddr[index+i] != 32) && (i < 31); i++) + product[i] = uc_ptaddr[index+i]; + + product[i] = '\0'; + pr_info("%s: BIOS Product Name = %s, line: %d", __func__, product, __LINE__); + + iounmap((void *)uc_ptaddr); + + return 0; +} + +static const struct mfd_cell adv_ec_sub_cells[] = { + { .name = "adv-ec-brightness", }, + { .name = "adv-ec-eeprom", }, + { .name = "adv-ec-gpio", }, + { .name = "adv-ec-hwmon", }, + { .name = "adv-ec-led", }, + { .name = "adv-ec-wdt", }, +}; + +static int adv_ec_init_ec_data(struct adv_ec_platform_data *pdata) +{ + int ret; + + pdata->sub_dev_mask = 0; + pdata->sub_dev_nb = 0; + pdata->dym_tbl = NULL; + pdata->bios_product_name = NULL; + + /* Get product name */ + pdata->bios_product_name = kmalloc(AMI_ADVANTECH_BOARD_ID_LENGTH, GFP_KERNEL); + if (!pdata->bios_product_name) + return -ENOMEM; + + memset(pdata->bios_product_name, 0, AMI_ADVANTECH_BOARD_ID_LENGTH); + ret = adv_ec_get_productname(pdata->bios_product_name); + if (ret) + return ret; + + /* Get pin table */ + pdata->dym_tbl = kmalloc(EC_MAX_TBL_NUM*sizeof(struct Dynamic_Tab), GFP_KERNEL); + if (!pdata->dym_tbl) + return -ENOMEM; + + ret = adv_get_dynamic_tab(pdata); + + return 0; +} + +static int adv_ec_parse_prop(struct adv_ec_platform_data *pdata) +{ + int i, ret; + u32 nb, sub_dev[ADVEC_SUBDEV_MAX]; + + ret = device_property_read_u32(pdata->dev, "advantech,sub-dev-nb", &nb); + if (ret < 0) { + dev_err(pdata->dev, "get sub-dev-nb failed! (%d)", ret); + return ret; + } + pdata->sub_dev_nb = nb; + + ret = device_property_read_u32_array(pdata->dev, "advantech,sub-dev", sub_dev, nb); + if (ret < 0) { + dev_err(pdata->dev, "get sub-dev failed! (%d)", ret); + return ret; + } + + for (i = 0; i < nb; i++) { + switch (sub_dev[i]) { + case ADVEC_SUBDEV_BRIGHTNESS: + case ADVEC_SUBDEV_EEPROM: + case ADVEC_SUBDEV_GPIO: + case ADVEC_SUBDEV_HWMON: + case ADVEC_SUBDEV_LED: + case ADVEC_SUBDEV_WDT: + pdata->sub_dev_mask |= BIT(sub_dev[i]); + break; + default: + dev_err(pdata->dev, "invalid prop value(%d)!", sub_dev[i]); + } + } + dev_info(pdata->dev, "sub-dev mask = 0x%x", pdata->sub_dev_mask); + + return 0; +} + +static int adv_ec_probe(struct platform_device *pdev) +{ + int ret, i; + struct device *dev = &pdev->dev; + struct adv_ec_platform_data *adv_ec_data; + + adv_ec_data = kmalloc(sizeof(struct adv_ec_platform_data), GFP_KERNEL); + if (!adv_ec_data) { + ret = -ENOMEM; + goto err_plat_data; + } + + dev_set_drvdata(dev, (void *)adv_ec_data); + adv_ec_data->dev = dev; + + mutex_init(&lock); + + ret = adv_ec_init_ec_data(adv_ec_data); + if (ret) + goto err_init_data; + + ret = adv_ec_parse_prop(adv_ec_data); + if (ret) + goto err_prop; + + for (i = 0; i < ARRAY_SIZE(adv_ec_sub_cells); i++) { + if (adv_ec_data->sub_dev_mask & BIT(i)) { + ret = mfd_add_hotplug_devices(dev, &adv_ec_sub_cells[i], 1); + if (ret) + dev_err(dev, "failed to add %s subdevice: %d", + adv_ec_sub_cells[i].name, ret); + } + } + + dev_info(&pdev->dev, "Ver:%s, Data:%s, probe done", + ADVANTECH_EC_MFD_VER, ADVANTECH_EC_MFD_DATE); + + return 0; + +err_prop: +err_init_data: + kfree(adv_ec_data->dym_tbl); + kfree(adv_ec_data->bios_product_name); + kfree(adv_ec_data); + +err_plat_data: + return ret; +} + +static int adv_ec_remove(struct platform_device *pdev) +{ + struct adv_ec_platform_data *adv_ec_data; + + adv_ec_data = (struct adv_ec_platform_data *)dev_get_drvdata(&pdev->dev); + + kfree(adv_ec_data->dym_tbl); + kfree(adv_ec_data->bios_product_name); + kfree(adv_ec_data); + + mfd_remove_devices(&pdev->dev); + mutex_destroy(&lock); + + return 0; +} + +#ifdef CONFIG_OF +static const struct of_device_id adv_ec_of_match[] = { + { .compatible = "advantech,ahc1ec0", }, + {} +}; +MODULE_DEVICE_TABLE(of, adv_ec_of_match); +#endif + +#ifdef CONFIG_ACPI +static const struct acpi_device_id adv_ec_acpi_match[] = { + {"AHC1EC0", }, + { }, +}; +MODULE_DEVICE_TABLE(acpi, adv_ec_acpi_match); +#endif + +static const struct platform_device_id adv_ec_id[] = { + { ADVANTECH_EC_NAME, }, + {} +}; +MODULE_DEVICE_TABLE(platform, adv_ec_id); + +static struct platform_driver adv_ec_driver = { + .driver = { + .name = ADVANTECH_EC_NAME, +#ifdef CONFIG_OF + .of_match_table = of_match_ptr(adv_ec_of_match), +#endif +#ifdef CONFIG_ACPI + .acpi_match_table = ACPI_PTR(adv_ec_acpi_match), +#endif + }, + .id_table = adv_ec_id, + .probe = adv_ec_probe, + .remove = adv_ec_remove, +}; +module_platform_driver(adv_ec_driver); + +MODULE_LICENSE("Dual BSD/GPL"); +MODULE_AUTHOR("sun.lang"); +MODULE_DESCRIPTION("Advantech EC MFD Driver."); + diff --git a/include/linux/mfd/ahc1ec0.h b/include/linux/mfd/ahc1ec0.h new file mode 100644 index 000000000000..a5a6f49c53e9 --- /dev/null +++ b/include/linux/mfd/ahc1ec0.h @@ -0,0 +1,338 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +#ifndef __LINUX_MFD_AHC1EC0_H +#define __LINUX_MFD_AHC1EC0_H + +#include + +#define uchar unsigned int + +#define EC_COMMAND_PORT 0x29A +#define EC_STATUS_PORT 0x299 + +#define EC_UDELAY_TIME 200 +#define EC_MAX_TIMEOUT_COUNT 5000 + +/* AD command */ +#define EC_AD_INDEX_WRITE 0x15 +#define EC_AD_LSB_READ 0x16 +#define EC_AD_MSB_READ 0x1F + +/* voltage device id */ +#define EC_DID_CMOSBAT 0x50 /* CMOS coin battery voltage */ +#define EC_DID_CMOSBAT_X2 0x51 /* CMOS coin battery voltage*2 */ +#define EC_DID_CMOSBAT_X10 0x52 /* CMOS coin battery voltage*10 */ +#define EC_DID_5VS0 0x56 /* 5VS0 voltage */ +#define EC_DID_5VS0_X2 0x57 /* 5VS0 voltage*2 */ +#define EC_DID_5VS0_X10 0x58 /* 5VS0 voltage*10 */ +#define EC_DID_5VS5 0x59 /* 5VS5 voltage */ +#define EC_DID_5VS5_X2 0x5A /* 5VS5 voltage*2 */ +#define EC_DID_5VS5_X10 0x5B /* 5VS5 voltage*10 */ +#define EC_DID_12VS0 0x62 /* 12VS0 voltage */ +#define EC_DID_12VS0_X2 0x63 /* 12VS0 voltage*2 */ +#define EC_DID_12VS0_X10 0x64 /* 12VS0 voltage*10 */ +#define EC_DID_VCOREA 0x65 /* CPU A core voltage */ +#define EC_DID_VCOREA_X2 0x66 /* CPU A core voltage*2 */ +#define EC_DID_VCOREA_X10 0x67 /* CPU A core voltage*10 */ +#define EC_DID_VCOREB 0x68 /* CPU B core voltage */ +#define EC_DID_VCOREB_X2 0x69 /* CPU B core voltage*2 */ +#define EC_DID_VCOREB_X10 0x6A /* CPU B core voltage*10 */ +#define EC_DID_DC 0x6B /* ADC. onboard voltage */ +#define EC_DID_DC_X2 0x6C /* ADC. onboard voltage*2 */ +#define EC_DID_DC_X10 0x6D /* ADC. onboard voltage*10 */ +#define EC_DID_SMBOEM0 0x28 /* SMBUS/I2C. Smbus channel 0 */ + +/* Current device id */ +#define EC_DID_CURRENT 0x74 + +/* ACPI commands */ +#define EC_ACPI_RAM_READ 0x80 +#define EC_ACPI_RAM_WRITE 0x81 + +/* + * Dynamic control table commands + * The table includes HW pin number,Device ID,and Pin polarity + */ +#define EC_TBL_WRITE_ITEM 0x20 +#define EC_TBL_GET_PIN 0x21 +#define EC_TBL_GET_DEVID 0x22 +#define EC_MAX_TBL_NUM 32 + +/* LED Device ID table */ +#define EC_DID_LED_RUN 0xE1 +#define EC_DID_LED_ERR 0xE2 +#define EC_DID_LED_SYS_RECOVERY 0xE3 +#define EC_DID_LED_D105_G 0xE4 +#define EC_DID_LED_D106_G 0xE5 +#define EC_DID_LED_D107_G 0xE6 + +/* LED control HW ram address 0xA0-0xAF */ +#define EC_HWRAM_LED_BASE_ADDR 0xA0 +#define EC_HWRAM_LED_PIN(N) (EC_HWRAM_LED_BASE_ADDR + (4 * (N))) // N:0-3 +#define EC_HWRAM_LED_CTRL_HIBYTE(N) (EC_HWRAM_LED_BASE_ADDR + (4 * (N)) + 1) +#define EC_HWRAM_LED_CTRL_LOBYTE(N) (EC_HWRAM_LED_BASE_ADDR + (4 * (N)) + 2) +#define EC_HWRAM_LED_DEVICE_ID(N) (EC_HWRAM_LED_BASE_ADDR + (4 * (N)) + 3) + +/* LED control bit */ +#define LED_CTRL_ENABLE_BIT (1 << 4) +#define LED_CTRL_INTCTL_BIT (1 << 5) +#define LED_CTRL_LEDBIT_MASK (0x03FF << 6) +#define LED_CTRL_POLARITY_MASK (0x000F << 0) +#define LED_CTRL_INTCTL_EXTERNAL 0 +#define LED_CTRL_INTCTL_INTERNAL 1 + +#define LED_DISABLE 0x0 +#define LED_ON 0x1 +#define LED_FAST 0x3 +#define LED_NORMAL 0x5 +#define LED_SLOW 0x7 +#define LED_MANUAL 0xF + +#define LED_CTRL_LEDBIT_DISABLE (0x0000) +#define LED_CTRL_LEDBIT_ON (0x03FF) +#define LED_CTRL_LEDBIT_FAST (0x02AA) +#define LED_CTRL_LEDBIT_NORMAL (0x0333) +#define LED_CTRL_LEDBIT_SLOW (0x03E0) + +/* Get the device name */ +#define AMI_BIOS_NAME "AMIBIOS" +#define AMI_BIOS_NAME_ADDRESS 0x000FF400 +#define AMI_BIOS_NAME_LENGTH strlen(AMI_BIOS_NAME) +#define AMI_ADVANTECH_BOARD_ID_ADDRESS 0x000FE840 +#define AMI_ADVANTECH_BOARD_ID_LENGTH 32 +#define AMI_ADVANTECH_BOARD_NAME_ADDRESS 0x000FF550 +#define AMI_ADVANTECH_BOARD_NAME_LENGTH _ADVANTECH_BOARD_NAME_LENGTH +#define AMI_UEFI_ADVANTECH_BOARD_NAME_ADDRESS 0x000F0000 +#define AMI_UEFI_ADVANTECH_BOARD_NAME_LENGTH 0xFFFF + +/* + * EC WDT commands + * EC can send multistage watchdog event. System can setup watchdog event + * independently to makeup event sequence. + */ +#define EC_WDT_START 0x28 +#define EC_WDT_STOP 0x29 +#define EC_WDT_RESET 0x2A +#define EC_WDT_BOOTTMEWDT_STOP 0x2B +#define EC_HW_RAM 0x89 +#define EC_EVENT_FLAG 0x57 +#define EC_RESET_EVENT 0x04 +#define EC_COMMANS_PORT_IBF_MASK 0x02 +#define EC_ENABLE_DELAY_L 0x59 +#define EC_ENABLE_DELAY_H 0x58 +#define EC_POWER_BTN_TIME_L 0x5B +#define EC_POWER_BTN_TIME_H 0x5A +#define EC_RESET_DELAY_TIME_L 0x5F +#define EC_RESET_DELAY_TIME_H 0x5E +#define EC_PIN_DELAY_TIME_L 0x61 +#define EC_PIN_DELAY_TIME_H 0x60 +#define EC_SCI_DELAY_TIME_H 0x62 +#define EC_SCI_DELAY_TIME_L 0x63 + +/* EC ACPI commands */ +#define EC_ACPI_DATA_READ 0x80 +#define EC_ACPI_DATA_WRITE 0x81 + +/* Brightness ACPI Addr */ +#define BRIGHTNESS_ACPI_ADDR 0x50 + +/* EC HW Ram commands */ +#define EC_HW_EXTEND_RAM_READ 0x86 +#define EC_HW_EXTEND_RAM_WRITE 0x87 +#define EC_HW_RAM_READ 0x88 +#define EC_HW_RAM_WRITE 0x89 + +/* EC Smbus commands */ +#define EC_SMBUS_CHANNEL_SET 0x8A /* Set selector number (SMBUS channel) */ +#define EC_SMBUS_ENABLE_I2C 0x8C /* Enable channel I2C */ +#define EC_SMBUS_DISABLE_I2C 0x8D /* Disable channel I2C */ + +/* Smbus transmit protocol */ +#define EC_SMBUS_PROTOCOL 0x00 + +/* SMBUS status */ +#define EC_SMBUS_STATUS 0x01 + +/* SMBUS device slave address (bit0 must be 0) */ +#define EC_SMBUS_SLV_ADDR 0x02 + +/* SMBUS device command */ +#define EC_SMBUS_CMD 0x03 + +/* 0x04-0x24 Data In read process, return data are stored in this address */ +#define EC_SMBUS_DATA 0x04 + +#define EC_SMBUS_DAT_OFFSET(n) (EC_SMBUS_DATA + (n)) + +/* SMBUS channel selector (0-4) */ +#define EC_SMBUS_CHANNEL 0x2B + +/* EC SMBUS transmit Protocol code */ +#define SMBUS_QUICK_WRITE 0x02 /* Write Quick Command */ +#define SMBUS_QUICK_READ 0x03 /* Read Quick Command */ +#define SMBUS_BYTE_SEND 0x04 /* Send Byte */ +#define SMBUS_BYTE_RECEIVE 0x05 /* Receive Byte */ +#define SMBUS_BYTE_WRITE 0x06 /* Write Byte */ +#define SMBUS_BYTE_READ 0x07 /* Read Byte */ +#define SMBUS_WORD_WRITE 0x08 /* Write Word */ +#define SMBUS_WORD_READ 0x09 /* Read Word */ +#define SMBUS_BLOCK_WRITE 0x0A /* Write Block */ +#define SMBUS_BLOCK_READ 0x0B /* Read Block */ +#define SMBUS_PROC_CALL 0x0C /* Process Call */ +#define SMBUS_BLOCK_PROC_CALL 0x0D /* Write Block-Read Block Process Call */ +#define SMBUS_I2C_READ_WRITE 0x0E /* I2C block Read-Write */ +#define SMBUS_I2C_WRITE_READ 0x0F /* I2C block Write-Read */ + +/* GPIO control commands */ +#define EC_GPIO_INDEX_WRITE 0x10 +#define EC_GPIO_STATUS_READ 0x11 +#define EC_GPIO_STATUS_WRITE 0x12 +#define EC_GPIO_DIR_READ 0x1D +#define EC_GPIO_DIR_WRITE 0x1E + +/* One Key Recovery commands */ +#define EC_ONE_KEY_FLAG 0x9C + +/* ASG OEM commands */ +#define EC_ASG_OEM 0xEA +#define EC_ASG_OEM_READ 0x00 +#define EC_ASG_OEM_WRITE 0x01 +#define EC_OEM_POWER_STATUS_VIN1 0X10 +#define EC_OEM_POWER_STATUS_VIN2 0X11 +#define EC_OEM_POWER_STATUS_BAT1 0X12 +#define EC_OEM_POWER_STATUS_BAT2 0X13 + +/* GPIO DEVICE ID */ +#define EC_DID_ALTGPIO_0 0x10 /* 0x10 AltGpio0 User define gpio */ +#define EC_DID_ALTGPIO_1 0x11 /* 0x11 AltGpio1 User define gpio */ +#define EC_DID_ALTGPIO_2 0x12 /* 0x12 AltGpio2 User define gpio */ +#define EC_DID_ALTGPIO_3 0x13 /* 0x13 AltGpio3 User define gpio */ +#define EC_DID_ALTGPIO_4 0x14 /* 0x14 AltGpio4 User define gpio */ +#define EC_DID_ALTGPIO_5 0x15 /* 0x15 AltGpio5 User define gpio */ +#define EC_DID_ALTGPIO_6 0x16 /* 0x16 AltGpio6 User define gpio */ +#define EC_DID_ALTGPIO_7 0x17 /* 0x17 AltGpio7 User define gpio */ + +/* Lmsensor Chip Register */ +#define NSLM96163_CHANNEL 0x02 + +/* NS_LM96163 address 0x98 */ +#define NSLM96163_ADDR 0x98 + +/* LM96163 index(0x00) Local Temperature (Signed MSB) */ +#define NSLM96163_LOC_TEMP 0x00 + +#define F75387_REG_R_MANU_ID 0x5D +#define F75387_REG_R_CHIP_ID 0x5A + +#define LMF75387_MANU_ID_FINTEK 0x1934 //VENDOR ID +#define LMF75387_CHIP_ID_F75387 0x0410 //CHIPID + +/* Lmsensor Chip SMUBS Slave Address */ +#define LMF75387_SMBUS_SLAVE_ADDRESS_5C 0x5c +#define LMF75387_SMBUS_SLAVE_ADDRESS_5A 0x5A +#define INA266_SMBUS_SLAVE_ADDRESS_8A 0x8A + +/* Temperature */ +#define F75387_REG_R_TEMP0_MSB 0x14 /* 1 degree */ +#define F75387_REG_R_TEMP0_LSB 0x1A /* 1/256 degree */ + +#define F75387_REG_R_TEMP1_MSB 0x15 /* 1 degree */ +#define F75387_REG_R_TEMP1_LSB 0x1B /* 1/256 degree */ + +/* LOCAL Temperature */ +#define F75387_REG_R_TEMP2_MSB 0x1C /* local temp., 1 degree */ +#define F75387_REG_R_TEMP2_LSB 0x1D /* 1/256 degree */ + +/* Voltage */ +#define F75387_REG_R_V1 0x11 /* 8mV */ +#define F75387_REG_R_V2 0x12 /* 8mV */ +#define F75387_REG_R_V3 0x13 /* 8mV */ + +/* HWMON registers */ +#define INA266_REG_VOLTAGE 0x02 /* 1.25mV */ +#define INA266_REG_POWER 0x03 /* 25mW */ +#define INA266_REG_CURRENT 0x04 /* 1mA */ + +struct HW_PIN_TBL { + uchar vbat[2]; + uchar v5[2]; + uchar v12[2]; + uchar vcore[2]; + uchar vdc[2]; + uchar ec_current[2]; + uchar power[2]; +}; + +struct Dynamic_Tab { + uchar DeviceID; + uchar HWPinNumber; +}; + +struct EC_SMBOEM0 { + uchar HWPinNumber; +}; + +struct EC_READ_HW_RAM { + unsigned int addr; + unsigned int data; +}; + +struct EC_WRITE_HW_RAM { + unsigned int addr; + unsigned int data; +}; + +struct EC_SMBUS_WORD_DATA { + unsigned char Channel; + unsigned char Address; + unsigned char Register; + unsigned short Value; +}; + +struct EC_SMBUS_READ_BYTE { + unsigned char Channel; + unsigned char Address; + unsigned char Register; + unsigned char Data; +}; + +struct EC_SMBUS_WRITE_BYTE { + unsigned char Channel; + unsigned char Address; + unsigned char Register; + unsigned char Data; +}; + +struct pled_hw_pin_tbl { + uchar pled[6]; +}; + +struct adv_ec_platform_data { + char *bios_product_name; + int sub_dev_nb; + u32 sub_dev_mask; + + struct device *dev; + struct class *adv_ec_class; + + struct Dynamic_Tab *dym_tbl; +}; + +int read_ad_value(uchar hwpin, uchar multi); +int read_acpi_value(uchar addr, uchar *pvalue); +int write_hw_ram(uchar addr, uchar data); +int write_hwram_command(uchar data); +int smbus_read_word(struct EC_SMBUS_WORD_DATA *ptr_ec_smbus_word_data); +int smbus_read_byte(struct EC_SMBUS_READ_BYTE *ptr_ec_smbus_read_byte); +int write_acpi_value(uchar addr, uchar value); +int read_gpio_status(uchar PinNumber, uchar *pvalue); +int write_gpio_status(uchar PinNumber, uchar value); +int read_gpio_dir(uchar PinNumber, uchar *pvalue); +int write_gpio_dir(uchar PinNumber, uchar value); +int write_hw_extend_ram(uchar addr, uchar data); +int smbus_write_byte(struct EC_SMBUS_WRITE_BYTE *ptr_ec_smbus_write_byte); +int read_onekey_status(uchar addr, uchar *pdata); +int write_onekey_status(uchar addr); +int ec_oem_get_status(uchar addr, uchar *pdata); +int ec_oem_set_status(uchar addr, uchar pdata); + +#endif /* __LINUX_MFD_AHC1EC0_H */