From: Simon Arlott Subject: Re: [PATCH (v7) 2/2] mtd: brcmnand: Add support for the BCM63268 Date: Wed, 2 Dec 2015 19:54:49 +0000 Message-ID: <565F4C89.5030609@simon.arlott.org.uk> References: <56523EFF.9050502@simon.arlott.org.uk> <56535977.9050201@gmail.com> <56541BD3.4070202@simon.arlott.org.uk> <5654AF69.7040901@gmail.com> <210ac819ff369893bd7d10640026a5b75455e684@8b5064a13e22126c1b9329f0dc35b8915774b7c3.invalid> <772c4df64731e4e4f5bbbb9051cea28aaf805f4e@8b5064a13e22126c1b9329f0dc35b8915774b7c3.invalid> <565610B9.5040407@simon.arlott.org.uk> <20151202191811.GK64635@google.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: QUOTED-PRINTABLE Return-path: In-Reply-To: <20151202191811.GK64635@google.com> Sender: linux-kernel-owner@vger.kernel.org To: Brian Norris Cc: Jonas Gorski , Florian Fainelli , Rob Herring , "devicetree@vger.kernel.org" , Linux Kernel Mailing List , David Woodhouse , MTD Maling List , Pawel Moll , Mark Rutland , Ian Campbell , Kumar Gala , bcm-kernel-feedback-list@broadcom.com, Kamal Dasu List-Id: devicetree@vger.kernel.org On 02/12/15 19:18, Brian Norris wrote: > + Broadcom list + Kamal >=20 > Hi Simon, >=20 > On Wed, Nov 25, 2015 at 07:49:13PM +0000, Simon Arlott wrote: >> The BCM63268 has a NAND interrupt register with combined status and = enable >> registers. It also has a clock for the NAND controller that needs to= be >> enabled. >>=20 >> Set up the device by enabling the clock, disabling and acking all >> interrupts, then handle the CTRL_READY interrupt. >>=20 >> Add a brcmnand_get_socdata() function so that bcm63268_nand can obta= in its >> data and disable the clock when the device is removed. >>=20 >> Signed-off-by: Simon Arlott >> --- >> Added EXPORT_SYMBOL_GPL(brcmnand_get_socdata) >>=20 >> (As the brcmnand module must be loaded first its compatible string w= ill >> apply to any existing devices before the soc-specific module can be >> loaded.) >=20 > What's this comment supposed to mean? The brcmnand module will not > directly probe any devices. It doesn't register any driver structs by > itself. I didn't notice that it didn't actually probe devices. In that case the documentation should not require "brcm,brcmnand" for soc-specific variants because the hardware's not really compatible with it. > (BTW given that, it probably doesn't need its MODULE_DEVICE_TABLE.) >=20 >> drivers/mtd/nand/brcmnand/Makefile | 1 + >> drivers/mtd/nand/brcmnand/bcm63268_nand.c | 179 +++++++++++++++++++= +++++++++++ >> drivers/mtd/nand/brcmnand/brcmnand.c | 8 ++ >> drivers/mtd/nand/brcmnand/brcmnand.h | 1 + >> 4 files changed, 189 insertions(+) >> create mode 100644 drivers/mtd/nand/brcmnand/bcm63268_nand.c >>=20 >> diff --git a/drivers/mtd/nand/brcmnand/Makefile b/drivers/mtd/nand/b= rcmnand/Makefile >> index 3b1fbfd..b83a9ae 100644 >> --- a/drivers/mtd/nand/brcmnand/Makefile >> +++ b/drivers/mtd/nand/brcmnand/Makefile >> @@ -2,5 +2,6 @@ >> # more specific iproc_nand.o, for instance >> obj-$(CONFIG_MTD_NAND_BRCMNAND) +=3D iproc_nand.o >> obj-$(CONFIG_MTD_NAND_BRCMNAND) +=3D bcm63138_nand.o >> +obj-$(CONFIG_MTD_NAND_BRCMNAND) +=3D bcm63268_nand.o >> obj-$(CONFIG_MTD_NAND_BRCMNAND) +=3D brcmstb_nand.o >> obj-$(CONFIG_MTD_NAND_BRCMNAND) +=3D brcmnand.o >> diff --git a/drivers/mtd/nand/brcmnand/bcm63268_nand.c b/drivers/mtd= /nand/brcmnand/bcm63268_nand.c >> new file mode 100644 >> index 0000000..70ad907 >> --- /dev/null >> +++ b/drivers/mtd/nand/brcmnand/bcm63268_nand.c >> @@ -0,0 +1,179 @@ >> +/* >> + * Copyright 2015 Simon Arlott >> + * >> + * This program is free software; you can redistribute it and/or mo= dify >> + * it under the terms of the GNU General Public License version 2 a= s >> + * published by the Free Software Foundation. >> + * >> + * This program is distributed in the hope that it will be useful, >> + * but WITHOUT ANY WARRANTY; without even the implied warranty of >> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the >> + * GNU General Public License for more details. >> + * >> + * Derived from bcm63138_nand.c: >> + * Copyright =C2=A9 2015 Broadcom Corporation >> + * >> + * Derived from bcm963xx_4.12L.06B_consumer/shared/opensource/inclu= de/bcm963xx/63268_map_part.h: >> + * Copyright 2000-2010 Broadcom Corporation >> + * >> + * Derived from bcm963xx_4.12L.06B_consumer/shared/opensource/flash= /nandflash.c: >> + * Copyright 2000-2010 Broadcom Corporation >> + */ >> + >> +#include >> +#include >> +#include >> +#include >> +#include >> +#include >> +#include >> +#include >> +#include >> + >> +#include "brcmnand.h" >> + >> +struct bcm63268_nand_soc { >> + struct brcmnand_soc soc; >> + void __iomem *base; >> + struct clk *clk; >> +}; >> + >> +#define BCM63268_NAND_INT 0x00 >> +#define BCM63268_NAND_STATUS_SHIFT 0 >> +#define BCM63268_NAND_STATUS_MASK (0xfff << BCM63268_NAND_STATUS_S= HIFT) >> +#define BCM63268_NAND_ENABLE_SHIFT 16 >> +#define BCM63268_NAND_ENABLE_MASK (0xffff << BCM63268_NAND_ENABLE_= SHIFT) >> +#define BCM63268_NAND_BASE_ADDR0 0x04 >> +#define BCM63268_NAND_BASE_ADDR1 0x0c >> + >> +enum { >> + BCM63268_NP_READ =3D BIT(0), >> + BCM63268_BLOCK_ERASE =3D BIT(1), >> + BCM63268_COPY_BACK =3D BIT(2), >> + BCM63268_PAGE_PGM =3D BIT(3), >> + BCM63268_CTRL_READY =3D BIT(4), >> + BCM63268_DEV_RBPIN =3D BIT(5), >> + BCM63268_ECC_ERR_UNC =3D BIT(6), >> + BCM63268_ECC_ERR_CORR =3D BIT(7), >> +}; >> + >> +static bool bcm63268_nand_intc_ack(struct brcmnand_soc *soc) >> +{ >> + struct bcm63268_nand_soc *priv =3D >> + container_of(soc, struct bcm63268_nand_soc, soc); >> + void __iomem *mmio =3D priv->base + BCM63268_NAND_INT; >> + u32 val =3D brcmnand_readl(mmio); >> + >> + if (val & (BCM63268_CTRL_READY << BCM63268_NAND_STATUS_SHIFT)) { >> + /* Ack interrupt */ >> + val &=3D ~BCM63268_NAND_STATUS_MASK; >> + val |=3D BCM63268_CTRL_READY << BCM63268_NAND_STATUS_SHIFT; >> + brcmnand_writel(val, mmio); >> + return true; >> + } >> + >> + return false; >> +} >> + >> +static void bcm63268_nand_intc_set(struct brcmnand_soc *soc, bool e= n) >> +{ >> + struct bcm63268_nand_soc *priv =3D >> + container_of(soc, struct bcm63268_nand_soc, soc); >> + void __iomem *mmio =3D priv->base + BCM63268_NAND_INT; >> + u32 val =3D brcmnand_readl(mmio); >> + >> + /* Don't ack any interrupts */ >> + val &=3D ~BCM63268_NAND_STATUS_MASK; >> + >> + if (en) >> + val |=3D BCM63268_CTRL_READY << BCM63268_NAND_ENABLE_SHIFT; >> + else >> + val &=3D ~(BCM63268_CTRL_READY << BCM63268_NAND_ENABLE_SHIFT); >> + >> + brcmnand_writel(val, mmio); >> +} >> + >> +static int bcm63268_nand_probe(struct platform_device *pdev) >> +{ >> + struct device *dev =3D &pdev->dev; >> + struct bcm63268_nand_soc *priv; >> + struct brcmnand_soc *soc; >> + struct resource *res; >> + int ret; >> + >> + priv =3D devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL); >> + if (!priv) >> + return -ENOMEM; >> + soc =3D &priv->soc; >> + >> + res =3D platform_get_resource_byname(pdev, >> + IORESOURCE_MEM, "nand-intr-base"); >> + if (!res) >> + return -EINVAL; >> + >> + priv->base =3D devm_ioremap_resource(dev, res); >> + if (IS_ERR(priv->base)) >> + return PTR_ERR(priv->base); >> + >> + priv->clk =3D devm_clk_get(&pdev->dev, "nand"); >> + if (IS_ERR(priv->clk)) >> + return PTR_ERR(priv->clk); >=20 > Perhaps we should put this clock handling in brcmnand.c? Just have it > treat the clock as optional (i.e., ignore errors except for > EPROBE_DEFER?), so we don't fail if no clock was provided? This could > help other platforms too, if they gain clock support. Unless most soc variants have clocks I'd prefer to leave it in this module. > If we do this, you'll want to document the clock in the common bindin= g, > not the bcm63268-specific part. >=20 > Also, could it help to disable/enable the clock during suspend/resume= ? > If you move it to brcmnand.c, this would also be pretty simple. Alternatively, it could proxy the brcmnand_pm_ops functions. I don't have any way to test suspend/resume. >> + >> + ret =3D clk_prepare_enable(priv->clk); >> + if (ret) >> + return ret; >> + >> + soc->ctlrdy_ack =3D bcm63268_nand_intc_ack; >> + soc->ctlrdy_set_enabled =3D bcm63268_nand_intc_set; >> + >> + /* Disable and ack all interrupts */ >> + brcmnand_writel(0, priv->base + BCM63268_NAND_INT); >> + brcmnand_writel(BCM63268_NAND_STATUS_MASK, >> + priv->base + BCM63268_NAND_INT); >> + >> + ret =3D brcmnand_probe(pdev, soc); >> + if (ret) >> + clk_disable_unprepare(priv->clk); >> + >> + return ret; >> +} >> + >> +static int bcm63268_nand_remove(struct platform_device *pdev) >> +{ >> + struct brcmnand_soc *soc =3D brcmnand_get_socdata(pdev); >> + struct bcm63268_nand_soc *priv =3D NULL; >> + int ret; >> + >> + if (soc) >> + priv =3D container_of(soc, struct bcm63268_nand_soc, soc); >> + >> + ret =3D brcmnand_remove(pdev); >> + if (ret) >> + return ret; >> + >> + if (priv) >> + clk_disable_unprepare(priv->clk); >> + >> + return 0; >> +} >> + >> +static const struct of_device_id bcm63268_nand_of_match[] =3D { >> + { .compatible =3D "brcm,nand-bcm63268" }, >> + {}, >> +}; >> +MODULE_DEVICE_TABLE(of, bcm63268_nand_of_match); >> + >> +static struct platform_driver bcm63268_nand_driver =3D { >> + .probe =3D bcm63268_nand_probe, >> + .remove =3D bcm63268_nand_remove, >> + .driver =3D { >> + .name =3D "bcm63268_nand", >> + .pm =3D &brcmnand_pm_ops, >> + .of_match_table =3D bcm63268_nand_of_match, >> + } >> +}; >> +module_platform_driver(bcm63268_nand_driver); >> + >> +MODULE_LICENSE("GPL"); >> +MODULE_AUTHOR("Simon Arlott"); >> +MODULE_DESCRIPTION("NAND driver for BCM63268"); >> diff --git a/drivers/mtd/nand/brcmnand/brcmnand.c b/drivers/mtd/nand= /brcmnand/brcmnand.c >> index 2c8f67f..5f26b8a 100644 >> --- a/drivers/mtd/nand/brcmnand/brcmnand.c >> +++ b/drivers/mtd/nand/brcmnand/brcmnand.c >> @@ -2262,6 +2262,14 @@ int brcmnand_probe(struct platform_device *pd= ev, struct brcmnand_soc *soc) >> } >> EXPORT_SYMBOL_GPL(brcmnand_probe); >> =20 >> +struct brcmnand_soc *brcmnand_get_socdata(struct platform_device *p= dev) >> +{ >> + struct brcmnand_controller *ctrl =3D dev_get_drvdata(&pdev->dev); >> + >> + return ctrl ? ctrl->soc : NULL; >> +} >> +EXPORT_SYMBOL_GPL(brcmnand_get_socdata); >=20 > If you move the clk handling to the core brcmnand.c, then you won't n= eed > this still. Would you prefer a clock name in the soc data structure that is used to call devm_clk_get()? >> + >> int brcmnand_remove(struct platform_device *pdev) >> { >> struct brcmnand_controller *ctrl =3D dev_get_drvdata(&pdev->dev); >> diff --git a/drivers/mtd/nand/brcmnand/brcmnand.h b/drivers/mtd/nand= /brcmnand/brcmnand.h >> index ef5eabb..6680419 100644 >> --- a/drivers/mtd/nand/brcmnand/brcmnand.h >> +++ b/drivers/mtd/nand/brcmnand/brcmnand.h >> @@ -65,6 +65,7 @@ static inline void brcmnand_writel(u32 val, void _= _iomem *addr) >> =20 >> int brcmnand_probe(struct platform_device *pdev, struct brcmnand_so= c *soc); >> int brcmnand_remove(struct platform_device *pdev); >> +struct brcmnand_soc *brcmnand_get_socdata(struct platform_device *p= dev); >> =20 >> extern const struct dev_pm_ops brcmnand_pm_ops; >> =20 >=20 > Brian >=20 --=20 Simon Arlott