From patchwork Tue Mar 24 22:30:19 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Srinivas Kandagatla X-Patchwork-Id: 46289 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wg0-f69.google.com (mail-wg0-f69.google.com [74.125.82.69]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 891472159D for ; Tue, 24 Mar 2015 22:30:48 +0000 (UTC) Received: by wggx13 with SMTP id x13sf1111083wgg.0 for ; Tue, 24 Mar 2015 15:30:47 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:delivered-to:from:to:cc:subject :date:message-id:in-reply-to:references:sender:precedence:list-id :x-original-sender:x-original-authentication-results:mailing-list :list-post:list-help:list-archive:list-unsubscribe; bh=tkYI6RnUHJnNfofuwNHJTnBAc3nHmoR9wGKKAnAkcpk=; b=mtit/Oc03uqOVh//QiSMZdtOFXl8ku+ESCTSFSxElwTvloAdOsMh2gbpGlTkZnJ0uu sFNkQJqqtCsFnNY/NrBdh1n2OLoadYtal1TsA3OJDYqtS8wYYxd7FM/TCVeVk81TSTco 3ERricxixV3zk/3lKl2+IS786lICwtKDfJp1pVAeL7BCKBQZ+88VgdQi+tq10l4L2dF7 KBJH5RMRv9avAPMKkyu29xJnNc2R7Mj88VkoZ25/PBakqtCV1IgIwFE88jlnGC00FPb0 JksFDY+GFrnMLffU/uZFqw4qVwcwnEDgv01tSCR13OJW1waPgeILjLR5/Eu/Q0JJBvF/ U5YA== X-Gm-Message-State: ALoCoQm3WXooifinA4nVZ8B/uhW0Vjs5dXdf1vzaWMK88spdt2JVWYT7LbyVWvEEKKorrwqpw9L8 X-Received: by 10.180.23.40 with SMTP id j8mr540145wif.2.1427236247862; Tue, 24 Mar 2015 15:30:47 -0700 (PDT) MIME-Version: 1.0 X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.197.97 with SMTP id it1ls30299lac.1.gmail; Tue, 24 Mar 2015 15:30:47 -0700 (PDT) X-Received: by 10.112.39.69 with SMTP id n5mr5668677lbk.1.1427236247689; Tue, 24 Mar 2015 15:30:47 -0700 (PDT) Received: from mail-la0-f52.google.com (mail-la0-f52.google.com. [209.85.215.52]) by mx.google.com with ESMTPS id u5si424267lbl.158.2015.03.24.15.30.47 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 24 Mar 2015 15:30:47 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.52 as permitted sender) client-ip=209.85.215.52; Received: by lagg8 with SMTP id g8so5836986lag.1 for ; Tue, 24 Mar 2015 15:30:47 -0700 (PDT) X-Received: by 10.112.130.100 with SMTP id od4mr5738234lbb.86.1427236247518; Tue, 24 Mar 2015 15:30:47 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.57.201 with SMTP id k9csp1732223lbq; Tue, 24 Mar 2015 15:30:46 -0700 (PDT) X-Received: by 10.66.66.166 with SMTP id g6mr11741821pat.88.1427236244526; Tue, 24 Mar 2015 15:30:44 -0700 (PDT) Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id ri8si728081pbc.225.2015.03.24.15.30.43; Tue, 24 Mar 2015 15:30:44 -0700 (PDT) Received-SPF: none (google.com: linux-arm-msm-owner@vger.kernel.org does not designate permitted sender hosts) client-ip=209.132.180.67; Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753440AbbCXWad (ORCPT + 5 others); Tue, 24 Mar 2015 18:30:33 -0400 Received: from mail-wg0-f52.google.com ([74.125.82.52]:35463 "EHLO mail-wg0-f52.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753417AbbCXWa2 (ORCPT ); Tue, 24 Mar 2015 18:30:28 -0400 Received: by wgdm6 with SMTP id m6so6451597wgd.2 for ; Tue, 24 Mar 2015 15:30:26 -0700 (PDT) X-Received: by 10.194.94.164 with SMTP id dd4mr12543558wjb.56.1427236226566; Tue, 24 Mar 2015 15:30:26 -0700 (PDT) Received: from srini-ThinkPad-X1-Carbon-2nd.dlink.com (host-2-99-228-8.as13285.net. [2.99.228.8]) by mx.google.com with ESMTPSA id md2sm17777030wic.19.2015.03.24.15.30.22 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 24 Mar 2015 15:30:25 -0700 (PDT) From: Srinivas Kandagatla To: linux-arm-kernel@lists.infradead.org Cc: Maxime Ripard , Rob Herring , Kumar Gala , Mark Brown , Greg Kroah-Hartman , linux-api@vger.kernel.org, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, linux-arm-msm@vger.kernel.org, arnd@arndb.de, sboyd@codeaurora.org, Srinivas Kandagatla Subject: [PATCH v3 4/9] eeprom: Add a simple EEPROM framework for eeprom consumers Date: Tue, 24 Mar 2015 22:30:19 +0000 Message-Id: <1427236219-18709-1-git-send-email-srinivas.kandagatla@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1427236116-18531-1-git-send-email-srinivas.kandagatla@linaro.org> References: <1427236116-18531-1-git-send-email-srinivas.kandagatla@linaro.org> Sender: linux-arm-msm-owner@vger.kernel.org Precedence: list List-ID: X-Mailing-List: linux-arm-msm@vger.kernel.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: srinivas.kandagatla@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.52 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 List-Post: , List-Help: , List-Archive: List-Unsubscribe: , This patch adds just consumers part of the framework just to enable easy review. Up until now, EEPROM drivers were stored in drivers/misc, where they all had to duplicate pretty much the same code to register a sysfs file, allow in-kernel users to access the content of the devices they were driving, etc. This was also a problem as far as other in-kernel users were involved, since the solutions used were pretty much different from on driver to another, there was a rather big abstraction leak. This introduction of this framework aims at solving this. It also introduces DT representation for consumer devices to go get the data they require (MAC Addresses, SoC/Revision ID, part numbers, and so on) from the EEPROMs. Having regmap interface to this framework would give much better abstraction for eeproms on different buses. Signed-off-by: Maxime Ripard [Maxime Ripard: intial version of the framework] Signed-off-by: Srinivas Kandagatla --- drivers/eeprom/core.c | 304 ++++++++++++++++++++++++++++++++++++++++ include/linux/eeprom-consumer.h | 67 +++++++++ 2 files changed, 371 insertions(+) create mode 100644 include/linux/eeprom-consumer.h diff --git a/drivers/eeprom/core.c b/drivers/eeprom/core.c index 9fd556c..43d03ef 100644 --- a/drivers/eeprom/core.c +++ b/drivers/eeprom/core.c @@ -16,6 +16,7 @@ #include #include +#include #include #include #include @@ -37,6 +38,13 @@ struct eeprom_device { int users; }; +struct eeprom_cell { + struct eeprom_device *eeprom; + int nblocks; + int size; + struct eeprom_block blocks[0]; +}; + static DEFINE_MUTEX(eeprom_mutex); static DEFINE_IDA(eeprom_ida); @@ -125,6 +133,37 @@ static struct class eeprom_class = { .dev_release = eeprom_release, }; +static int of_eeprom_match(struct device *dev, const void *eeprom_np) +{ + return dev->of_node == eeprom_np; +} + +static struct eeprom_device *of_eeprom_find(struct device_node *eeprom_np) +{ + struct device *d; + + if (!eeprom_np) + return NULL; + + d = class_find_device(&eeprom_class, NULL, eeprom_np, of_eeprom_match); + + return d ? to_eeprom(d) : NULL; +} + +static int eeprom_match(struct device *dev, const void *data) +{ + return !strcmp(dev_name(dev), (const char *)data); +} + +static struct eeprom_device *eeprom_find(const char *name) +{ + struct device *d; + + d = class_find_device(&eeprom_class, NULL, (void *)name, eeprom_match); + + return d ? to_eeprom(d) : NULL; +} + /** * eeprom_register(): Register a eeprom device for given eeprom. * Also creates an binary entry in /sys/class/eeprom/name-id/eeprom @@ -208,6 +247,271 @@ int eeprom_unregister(struct eeprom_device *eeprom) } EXPORT_SYMBOL_GPL(eeprom_unregister); +static int eeprom_cell_sanity_check(struct eeprom_cell *cell) +{ + struct eeprom_device *eeprom = cell->eeprom; + int i; + + /* byte aligned, no need to check for stride sanity */ + if (eeprom->stride == 1) + return 0; + + for (i = 0; i < cell->nblocks; i++) { + if (!IS_ALIGNED(cell->blocks[i].offset, eeprom->stride) || + !IS_ALIGNED(cell->blocks[i].count, eeprom->stride)) { + dev_err(&eeprom->dev, + "cell unaligned to eeprom stride %d\n", + eeprom->stride); + return -EINVAL; + } + } + + return 0; +} + +static struct eeprom_cell *__eeprom_cell_get(struct device_node *cell_np, + const char *ename, + struct eeprom_block *blocks, + int nblocks) +{ + struct eeprom_cell *cell; + struct eeprom_device *eeprom = NULL; + struct property *prop; + const __be32 *vp; + u32 pv; + int i, rval; + + mutex_lock(&eeprom_mutex); + + eeprom = cell_np ? of_eeprom_find(cell_np->parent) : eeprom_find(ename); + if (!eeprom) { + mutex_unlock(&eeprom_mutex); + return ERR_PTR(-EPROBE_DEFER); + } + + eeprom->users++; + mutex_unlock(&eeprom_mutex); + + if (!try_module_get(eeprom->owner)) { + dev_err(&eeprom->dev, + "could not increase module refcount for cell %s\n", + ename); + rval = -EINVAL; + goto err_mod; + } + + if (cell_np) + nblocks = of_property_count_u32_elems(cell_np, "reg") / 2; + + cell = kzalloc(sizeof(*cell) + nblocks * sizeof(*blocks), GFP_KERNEL); + if (!cell) { + rval = -ENOMEM; + goto err_mem; + } + + cell->nblocks = nblocks; + cell->eeprom = eeprom; + cell->size = 0; + i = 0; + + if (cell_np) { + of_property_for_each_u32(cell_np, "reg", prop, vp, pv) { + cell->blocks[i].offset = pv; + vp = of_prop_next_u32(prop, vp, &pv); + cell->blocks[i].count = pv; + cell->size += pv; + i++; + } + } else { + memcpy(cell->blocks, blocks, nblocks * sizeof(*blocks)); + for (; i < nblocks; i++) + cell->size += blocks[i].count; + } + + if (IS_ERR_VALUE(eeprom_cell_sanity_check(cell))) { + rval = -EINVAL; + goto err_sanity; + } + + return cell; + +err_sanity: + kfree(cell); + +err_mem: + module_put(eeprom->owner); + +err_mod: + mutex_lock(&eeprom_mutex); + eeprom->users--; + mutex_unlock(&eeprom_mutex); + + return ERR_PTR(rval); + +} + +/** + * eeprom_cell_get(): Get eeprom cell of device form a given eeprom name + * and blocks. + * + * @ename: eeprom device name that needs to be looked-up. + * @blocks: eeprom blocks containing offset and length information. + * @nblocks: number of eeprom blocks. + * + * The return value will be an ERR_PTR() on error or a valid pointer + * to a struct eeprom_cell. The eeprom_cell will be freed by the + * eeprom_cell_put(). + */ +struct eeprom_cell *eeprom_cell_get(const char *ename, + struct eeprom_block *blocks, int nblocks) +{ + return __eeprom_cell_get(NULL, ename, blocks, nblocks); +} +EXPORT_SYMBOL_GPL(eeprom_cell_get); + +/** + * of_eeprom_cell_get(): Get eeprom cell of device form a given index + * + * @dev: Device that will be interacted with + * @index: eeprom index in eeproms property. + * + * The return value will be an ERR_PTR() on error or a valid pointer + * to a struct eeprom_cell. The eeprom_cell will be freed by the + * eeprom_cell_put(). + */ +struct eeprom_cell *of_eeprom_cell_get(struct device *dev, int index) +{ + struct device_node *cell_np; + + if (!dev || !dev->of_node) + return ERR_PTR(-EINVAL); + + cell_np = of_parse_phandle(dev->of_node, "eeproms", index); + if (!cell_np) + return ERR_PTR(-EPROBE_DEFER); + + return __eeprom_cell_get(cell_np, NULL, NULL, 0); +} +EXPORT_SYMBOL_GPL(of_eeprom_cell_get); + +/** + * of_eeprom_cell_get_byname(): Get eeprom cell of device form a given name + * + * @dev: Device that will be interacted with + * @name: eeprom name in eeprom-names property. + * + * The return value will be an ERR_PTR() on error or a valid pointer + * to a struct eeprom_cell. The eeprom_cell will be freed by the + * eeprom_cell_put(). + */ +struct eeprom_cell *of_eeprom_cell_get_byname(struct device *dev, + const char *id) +{ + int index = 0; + + if (!dev || !dev->of_node) + return ERR_PTR(-EINVAL); + + if (id) + index = of_property_match_string(dev->of_node, + "eeprom-names", + id); + return of_eeprom_cell_get(dev, index); + +} +EXPORT_SYMBOL_GPL(of_eeprom_cell_get_byname); + +/** + * eeprom_cell_put(): Release previously allocated eeprom cell. + * + * @cell: Previously allocated eeprom cell by eeprom_cell_get() + * or of_eeprom_cell_get() or of_eeprom_cell_get_byname(). + */ +void eeprom_cell_put(struct eeprom_cell *cell) +{ + struct eeprom_device *eeprom = cell->eeprom; + + mutex_lock(&eeprom_mutex); + eeprom->users--; + mutex_unlock(&eeprom_mutex); + module_put(eeprom->owner); + kfree(cell); +} +EXPORT_SYMBOL_GPL(eeprom_cell_put); + +/** + * eeprom_cell_read(): Read a given eeprom cell + * + * @cell: eeprom cell to be read. + * @len: pointer to length of cell which will be populated on successful read. + * + * The return value will be an ERR_PTR() on error or a valid pointer + * to a char * bufffer. The buffer should be freed by the consumer with a + * kfree(). + */ +char *eeprom_cell_read(struct eeprom_cell *cell, ssize_t *len) +{ + struct eeprom_device *eeprom = cell->eeprom; + char *buf; + int rc, i, offset = 0; + + if (!eeprom || !eeprom->regmap) + return ERR_PTR(-EINVAL); + + buf = kzalloc(cell->size, GFP_KERNEL); + if (!buf) + return ERR_PTR(-ENOMEM); + + for (i = 0; i < cell->nblocks; i++) { + rc = regmap_bulk_read(eeprom->regmap, cell->blocks[i].offset, + buf + offset, + cell->blocks[i].count); + + if (IS_ERR_VALUE(rc)) { + kfree(buf); + return ERR_PTR(rc); + } + offset += cell->blocks[i].count; + } + + *len = cell->size; + + return buf; +} +EXPORT_SYMBOL_GPL(eeprom_cell_read); + +/** + * eeprom_cell_write(): Write to a given eeprom cell + * + * @cell: eeprom cell to be written. + * @buf: Buffer to be written. + * @len: length of buffer to be written to eeprom cell. + * + * The return value will be an non zero on error or a zero on successful write. + */ +int eeprom_cell_write(struct eeprom_cell *cell, const char *buf, ssize_t len) +{ + struct eeprom_device *eeprom = cell->eeprom; + int i, rc, offset = 0; + + if (!eeprom || !eeprom->regmap || len != cell->size) + return -EINVAL; + + for (i = 0; i < cell->nblocks; i++) { + rc = regmap_bulk_write(eeprom->regmap, cell->blocks[i].offset, + buf + offset, + cell->blocks[i].count); + + if (IS_ERR_VALUE(rc)) + return rc; + + offset += cell->blocks[i].count; + } + + return len; +} +EXPORT_SYMBOL_GPL(eeprom_cell_write); + static int eeprom_init(void) { return class_register(&eeprom_class); diff --git a/include/linux/eeprom-consumer.h b/include/linux/eeprom-consumer.h new file mode 100644 index 0000000..6d9d075 --- /dev/null +++ b/include/linux/eeprom-consumer.h @@ -0,0 +1,67 @@ +/* + * EEPROM framework consumer. + * + * Copyright (C) 2015 Srinivas Kandagatla + * Copyright (C) 2013 Maxime Ripard + * + * This file is licensed under the terms of the GNU General Public + * License version 2. This program is licensed "as is" without any + * warranty of any kind, whether express or implied. + */ + +#ifndef _LINUX_EEPROM_CONSUMER_H +#define _LINUX_EEPROM_CONSUMER_H + +struct eeprom_cell; + +struct eeprom_block { + loff_t offset; + size_t count; +}; +#if IS_ENABLED(CONFIG_EEPROM) +struct eeprom_cell *eeprom_cell_get(const char *ename, + struct eeprom_block *blocks, int nblocks); +void eeprom_cell_put(struct eeprom_cell *cell); +char *eeprom_cell_read(struct eeprom_cell *cell, ssize_t *len); +int eeprom_cell_write(struct eeprom_cell *cell, const char *buf, ssize_t len); +#else + +static inline struct eeprom_cell *eeprom_cell_get(const char *ename, + struct eeprom_block *blocks, int nblocks) +{ + return NULL; +} + +static inline void eeprom_cell_put(struct eeprom_cell *cell) +{ +} + +static inline char *eeprom_cell_read(struct eeprom_cell *cell, ssize_t *len) +{ + return NULL; +} + +static inline int eeprom_cell_write(struct eeprom_cell *cell, + const char *buf, ssize_t len) +{ + return -ENOSYS; +} +#endif /* CONFIG_EEPROM */ + +#if IS_ENABLED(CONFIG_EEPROM) && IS_ENABLED(CONFIG_OF) +struct eeprom_cell *of_eeprom_cell_get(struct device *dev, int index); +struct eeprom_cell *of_eeprom_cell_get_byname(struct device *dev, + const char *name); +#else +static inline struct eeprom_cell *of_eeprom_cell_get( + struct device *dev, int index) +{ + return NULL; +} +static inline struct eeprom_cell *of_eeprom_cell_get_byname(struct device *dev, + const char *name) +{ + return NULL; +} +#endif +#endif /* ifndef _LINUX_EEPROM_CONSUMER_H */