bcm6368_nand.c

  1// SPDX-License-Identifier: GPL-2.0-only
  2/*
  3 * Copyright 2015 Simon Arlott
  4 *
  5 * Derived from bcm63138_nand.c:
  6 * Copyright © 2015 Broadcom Corporation
  7 *
  8 * Derived from bcm963xx_4.12L.06B_consumer/shared/opensource/include/bcm963xx/63268_map_part.h:
  9 * Copyright 2000-2010 Broadcom Corporation
 10 *
 11 * Derived from bcm963xx_4.12L.06B_consumer/shared/opensource/flash/nandflash.c:
 12 * Copyright 2000-2010 Broadcom Corporation
 13 */
 14
 15#include <linux/device.h>
 16#include <linux/io.h>
 17#include <linux/ioport.h>
 18#include <linux/module.h>
 19#include <linux/of.h>
 20#include <linux/of_address.h>
 21#include <linux/platform_device.h>
 22#include <linux/slab.h>
 23
 24#include "brcmnand.h"
 25
 26struct bcm6368_nand_soc {
 27	struct brcmnand_soc soc;
 28	void __iomem *base;
 29};
 30
 31#define BCM6368_NAND_INT		0x00
 32#define  BCM6368_NAND_STATUS_SHIFT	0
 33#define  BCM6368_NAND_STATUS_MASK	(0xfff << BCM6368_NAND_STATUS_SHIFT)
 34#define  BCM6368_NAND_ENABLE_SHIFT	16
 35#define  BCM6368_NAND_ENABLE_MASK	(0xffff << BCM6368_NAND_ENABLE_SHIFT)
 36#define BCM6368_NAND_BASE_ADDR0	0x04
 37#define BCM6368_NAND_BASE_ADDR1	0x0c
 38
 39enum {
 40	BCM6368_NP_READ		= BIT(0),
 41	BCM6368_BLOCK_ERASE	= BIT(1),
 42	BCM6368_COPY_BACK	= BIT(2),
 43	BCM6368_PAGE_PGM	= BIT(3),
 44	BCM6368_CTRL_READY	= BIT(4),
 45	BCM6368_DEV_RBPIN	= BIT(5),
 46	BCM6368_ECC_ERR_UNC	= BIT(6),
 47	BCM6368_ECC_ERR_CORR	= BIT(7),
 48};
 49
 50static bool bcm6368_nand_intc_ack(struct brcmnand_soc *soc)
 51{
 52	struct bcm6368_nand_soc *priv =
 53			container_of(soc, struct bcm6368_nand_soc, soc);
 54	void __iomem *mmio = priv->base + BCM6368_NAND_INT;
 55	u32 val = brcmnand_readl(mmio);
 56
 57	if (val & (BCM6368_CTRL_READY << BCM6368_NAND_STATUS_SHIFT)) {
 58		/* Ack interrupt */
 59		val &= ~BCM6368_NAND_STATUS_MASK;
 60		val |= BCM6368_CTRL_READY << BCM6368_NAND_STATUS_SHIFT;
 61		brcmnand_writel(val, mmio);
 62		return true;
 63	}
 64
 65	return false;
 66}
 67
 68static void bcm6368_nand_intc_set(struct brcmnand_soc *soc, bool en)
 69{
 70	struct bcm6368_nand_soc *priv =
 71			container_of(soc, struct bcm6368_nand_soc, soc);
 72	void __iomem *mmio = priv->base + BCM6368_NAND_INT;
 73	u32 val = brcmnand_readl(mmio);
 74
 75	/* Don't ack any interrupts */
 76	val &= ~BCM6368_NAND_STATUS_MASK;
 77
 78	if (en)
 79		val |= BCM6368_CTRL_READY << BCM6368_NAND_ENABLE_SHIFT;
 80	else
 81		val &= ~(BCM6368_CTRL_READY << BCM6368_NAND_ENABLE_SHIFT);
 82
 83	brcmnand_writel(val, mmio);
 84}
 85
 86static int bcm6368_nand_probe(struct platform_device *pdev)
 87{
 88	struct device *dev = &pdev->dev;
 89	struct bcm6368_nand_soc *priv;
 90	struct brcmnand_soc *soc;
 91
 92	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
 93	if (!priv)
 94		return -ENOMEM;
 95	soc = &priv->soc;
 96
 97	priv->base = devm_platform_ioremap_resource_byname(pdev, "nand-int-base");
 98	if (IS_ERR(priv->base))
 99		return PTR_ERR(priv->base);
100
101	soc->ctlrdy_ack = bcm6368_nand_intc_ack;
102	soc->ctlrdy_set_enabled = bcm6368_nand_intc_set;
103
104	/* Disable and ack all interrupts  */
105	brcmnand_writel(0, priv->base + BCM6368_NAND_INT);
106	brcmnand_writel(BCM6368_NAND_STATUS_MASK,
107			priv->base + BCM6368_NAND_INT);
108
109	return brcmnand_probe(pdev, soc);
110}
111
112static const struct of_device_id bcm6368_nand_of_match[] = {
113	{ .compatible = "brcm,nand-bcm6368" },
114	{},
115};
116MODULE_DEVICE_TABLE(of, bcm6368_nand_of_match);
117
118static struct platform_driver bcm6368_nand_driver = {
119	.probe			= bcm6368_nand_probe,
120	.remove			= brcmnand_remove,
121	.driver = {
122		.name		= "bcm6368_nand",
123		.pm		= &brcmnand_pm_ops,
124		.of_match_table	= bcm6368_nand_of_match,
125	}
126};
127module_platform_driver(bcm6368_nand_driver);
128
129MODULE_LICENSE("GPL");
130MODULE_AUTHOR("Simon Arlott");
131MODULE_DESCRIPTION("NAND driver for BCM6368");