All of lore.kernel.org
 help / color / mirror / Atom feed
From: Tarun Kanti DebBarma <tarun.kanti@ti.com>
To: linux-omap@vger.kernel.org
Cc: khilman@ti.com, santosh.shilimkar@ti.com, tony@atomide.com,
	linux-arm-kernel@lists.infradead.org,
	Tarun Kanti DebBarma <tarun.kanti@ti.com>,
	Charulatha V <charu@ti.com>
Subject: [PATCH v5 13/22] gpio/omap: cleanup omap_gpio_mod_init function
Date: Thu, 4 Aug 2011 16:34:44 +0530	[thread overview]
Message-ID: <1312455893-14922-14-git-send-email-tarun.kanti@ti.com> (raw)
In-Reply-To: <1312455893-14922-1-git-send-email-tarun.kanti@ti.com>

With register offsets now defined for respective OMAP versions we can get rid
of cpu_class_* checks. This function now has common initialization code for
all OMAP versions. Initialization specific to OMAP16xx has been moved within
omap16xx_gpio_init().

Signed-off-by: Tarun Kanti DebBarma <tarun.kanti@ti.com>
Signed-off-by: Charulatha V <charu@ti.com>
---
 arch/arm/mach-omap1/gpio16xx.c |   34 ++++++++++++++++++-
 drivers/gpio/gpio-omap.c       |   71 +++++++++++-----------------------------
 2 files changed, 52 insertions(+), 53 deletions(-)

diff --git a/arch/arm/mach-omap1/gpio16xx.c b/arch/arm/mach-omap1/gpio16xx.c
index f619805..61b1998 100644
--- a/arch/arm/mach-omap1/gpio16xx.c
+++ b/arch/arm/mach-omap1/gpio16xx.c
@@ -24,6 +24,8 @@
 #define OMAP1610_GPIO4_BASE		0xfffbbc00
 #define OMAP1_MPUIO_VBASE		OMAP1_MPUIO_BASE
 
+#define SYSCONFIG_WORD			0x14 /* smart idle, enable wakeup */
+
 /* mpu gpio */
 static struct __initdata resource omap16xx_mpu_gpio_resources[] = {
 	{
@@ -218,12 +220,42 @@ static struct __initdata platform_device * omap16xx_gpio_dev[] = {
 static int __init omap16xx_gpio_init(void)
 {
 	int i;
+	void __iomem *base;
+	struct resource *res;
+	struct platform_device *pdev;
+	struct omap_gpio_platform_data *pdata;
 
 	if (!cpu_is_omap16xx())
 		return -EINVAL;
 
-	for (i = 0; i < ARRAY_SIZE(omap16xx_gpio_dev); i++)
+	for (i = 0; i < ARRAY_SIZE(omap16xx_gpio_dev); i++) {
+		pdev = omap16xx_gpio_dev[i];
+		pdata = pdev->dev.platform_data;
+
+		res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+		if (unlikely(!res)) {
+			dev_err(&pdev->dev, "Invalid mem resource.\n");
+			return -ENODEV;
+		}
+
+		base = ioremap(res->start, resource_size(res));
+		if (unlikely(!base)) {
+			dev_err(&pdev->dev, "ioremap failed.\n");
+			return -ENOMEM;
+		}
+
+		__raw_writel(SYSCONFIG_WORD, base + OMAP1610_GPIO_SYSCONFIG);
+		iounmap(base);
+
+		/*
+		 * Enable system clock for GPIO module.
+		 * The CAM_CLK_CTRL *is* really the right place.
+		 */
+		omap_writel(omap_readl(ULPD_CAM_CLK_CTRL) | 0x04,
+					ULPD_CAM_CLK_CTRL);
+
 		platform_device_register(omap16xx_gpio_dev[i]);
+	}
 
 	return 0;
 }
diff --git a/drivers/gpio/gpio-omap.c b/drivers/gpio/gpio-omap.c
index 21cb0d4..f6855e5 100644
--- a/drivers/gpio/gpio-omap.c
+++ b/drivers/gpio/gpio-omap.c
@@ -875,62 +875,24 @@ static void __init omap_gpio_show_rev(struct gpio_bank *bank)
  */
 static struct lock_class_key gpio_lock_class;
 
-/* TODO: Cleanup cpu_is_* checks */
 static void omap_gpio_mod_init(struct gpio_bank *bank)
 {
-	if (cpu_class_is_omap2()) {
-		if (cpu_is_omap44xx()) {
-			__raw_writel(0xffffffff, bank->base +
-					OMAP4_GPIO_IRQSTATUSCLR0);
-			__raw_writel(0x00000000, bank->base +
-					 OMAP4_GPIO_DEBOUNCENABLE);
-			/* Initialize interface clk ungated, module enabled */
-			__raw_writel(0, bank->base + OMAP4_GPIO_CTRL);
-		} else if (cpu_is_omap34xx()) {
-			__raw_writel(0x00000000, bank->base +
-					OMAP24XX_GPIO_IRQENABLE1);
-			__raw_writel(0xffffffff, bank->base +
-					OMAP24XX_GPIO_IRQSTATUS1);
-			__raw_writel(0x00000000, bank->base +
-					OMAP24XX_GPIO_DEBOUNCE_EN);
-
-			/* Initialize interface clk ungated, module enabled */
-			__raw_writel(0, bank->base + OMAP24XX_GPIO_CTRL);
-		}
-	} else if (cpu_class_is_omap1()) {
-		if (bank_is_mpuio(bank)) {
-			__raw_writew(0xffff, bank->base +
-				OMAP_MPUIO_GPIO_MASKIT / bank->stride);
-			mpuio_init(bank);
-		}
-		if (cpu_is_omap15xx() && bank->method == METHOD_GPIO_1510) {
-			__raw_writew(0xffff, bank->base
-						+ OMAP1510_GPIO_INT_MASK);
-			__raw_writew(0x0000, bank->base
-						+ OMAP1510_GPIO_INT_STATUS);
-		}
-		if (cpu_is_omap16xx() && bank->method == METHOD_GPIO_1610) {
-			__raw_writew(0x0000, bank->base
-						+ OMAP1610_GPIO_IRQENABLE1);
-			__raw_writew(0xffff, bank->base
-						+ OMAP1610_GPIO_IRQSTATUS1);
-			__raw_writew(0x0014, bank->base
-						+ OMAP1610_GPIO_SYSCONFIG);
+	void __iomem *base = bank->base;
+	u32 l = 0xffffffff;
 
-			/*
-			 * Enable system clock for GPIO module.
-			 * The CAM_CLK_CTRL *is* really the right place.
-			 */
-			omap_writel(omap_readl(ULPD_CAM_CLK_CTRL) | 0x04,
-						ULPD_CAM_CLK_CTRL);
-		}
-		if (cpu_is_omap7xx() && bank->method == METHOD_GPIO_7XX) {
-			__raw_writel(0xffffffff, bank->base
-						+ OMAP7XX_GPIO_INT_MASK);
-			__raw_writel(0x00000000, bank->base
-						+ OMAP7XX_GPIO_INT_STATUS);
-		}
+	if (bank->width == 16)
+		l = 0xffff;
+
+	if (bank_is_mpuio(bank)) {
+		__raw_writel(l, bank->base + bank->regs->irqenable);
+		return;
 	}
+
+	_gpio_rmw(base, bank->regs->irqenable, l, bank->regs->irqenable_inv);
+	_gpio_rmw(base, bank->regs->irqstatus, l,
+					bank->regs->irqenable_inv == false);
+	_gpio_rmw(base, bank->regs->irqenable, l, bank->regs->debounce_en != 0);
+	_gpio_rmw(base, bank->regs->irqenable, l, bank->regs->ctrl != 0);
 }
 
 static __init void
@@ -1074,6 +1036,11 @@ static int __devinit omap_gpio_probe(struct platform_device *pdev)
 	pm_runtime_enable(bank->dev);
 	pm_runtime_get_sync(bank->dev);
 
+	if (bank_is_mpuio(bank)) {
+		if (bank->regs->wkup_status)
+			mpuio_init(bank);
+	}
+
 	omap_gpio_mod_init(bank);
 	omap_gpio_chip_init(bank);
 	omap_gpio_show_rev(bank);
-- 
1.7.0.4


WARNING: multiple messages have this Message-ID (diff)
From: tarun.kanti@ti.com (Tarun Kanti DebBarma)
To: linux-arm-kernel@lists.infradead.org
Subject: [PATCH v5 13/22] gpio/omap: cleanup omap_gpio_mod_init function
Date: Thu, 4 Aug 2011 16:34:44 +0530	[thread overview]
Message-ID: <1312455893-14922-14-git-send-email-tarun.kanti@ti.com> (raw)
In-Reply-To: <1312455893-14922-1-git-send-email-tarun.kanti@ti.com>

With register offsets now defined for respective OMAP versions we can get rid
of cpu_class_* checks. This function now has common initialization code for
all OMAP versions. Initialization specific to OMAP16xx has been moved within
omap16xx_gpio_init().

Signed-off-by: Tarun Kanti DebBarma <tarun.kanti@ti.com>
Signed-off-by: Charulatha V <charu@ti.com>
---
 arch/arm/mach-omap1/gpio16xx.c |   34 ++++++++++++++++++-
 drivers/gpio/gpio-omap.c       |   71 +++++++++++-----------------------------
 2 files changed, 52 insertions(+), 53 deletions(-)

diff --git a/arch/arm/mach-omap1/gpio16xx.c b/arch/arm/mach-omap1/gpio16xx.c
index f619805..61b1998 100644
--- a/arch/arm/mach-omap1/gpio16xx.c
+++ b/arch/arm/mach-omap1/gpio16xx.c
@@ -24,6 +24,8 @@
 #define OMAP1610_GPIO4_BASE		0xfffbbc00
 #define OMAP1_MPUIO_VBASE		OMAP1_MPUIO_BASE
 
+#define SYSCONFIG_WORD			0x14 /* smart idle, enable wakeup */
+
 /* mpu gpio */
 static struct __initdata resource omap16xx_mpu_gpio_resources[] = {
 	{
@@ -218,12 +220,42 @@ static struct __initdata platform_device * omap16xx_gpio_dev[] = {
 static int __init omap16xx_gpio_init(void)
 {
 	int i;
+	void __iomem *base;
+	struct resource *res;
+	struct platform_device *pdev;
+	struct omap_gpio_platform_data *pdata;
 
 	if (!cpu_is_omap16xx())
 		return -EINVAL;
 
-	for (i = 0; i < ARRAY_SIZE(omap16xx_gpio_dev); i++)
+	for (i = 0; i < ARRAY_SIZE(omap16xx_gpio_dev); i++) {
+		pdev = omap16xx_gpio_dev[i];
+		pdata = pdev->dev.platform_data;
+
+		res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+		if (unlikely(!res)) {
+			dev_err(&pdev->dev, "Invalid mem resource.\n");
+			return -ENODEV;
+		}
+
+		base = ioremap(res->start, resource_size(res));
+		if (unlikely(!base)) {
+			dev_err(&pdev->dev, "ioremap failed.\n");
+			return -ENOMEM;
+		}
+
+		__raw_writel(SYSCONFIG_WORD, base + OMAP1610_GPIO_SYSCONFIG);
+		iounmap(base);
+
+		/*
+		 * Enable system clock for GPIO module.
+		 * The CAM_CLK_CTRL *is* really the right place.
+		 */
+		omap_writel(omap_readl(ULPD_CAM_CLK_CTRL) | 0x04,
+					ULPD_CAM_CLK_CTRL);
+
 		platform_device_register(omap16xx_gpio_dev[i]);
+	}
 
 	return 0;
 }
diff --git a/drivers/gpio/gpio-omap.c b/drivers/gpio/gpio-omap.c
index 21cb0d4..f6855e5 100644
--- a/drivers/gpio/gpio-omap.c
+++ b/drivers/gpio/gpio-omap.c
@@ -875,62 +875,24 @@ static void __init omap_gpio_show_rev(struct gpio_bank *bank)
  */
 static struct lock_class_key gpio_lock_class;
 
-/* TODO: Cleanup cpu_is_* checks */
 static void omap_gpio_mod_init(struct gpio_bank *bank)
 {
-	if (cpu_class_is_omap2()) {
-		if (cpu_is_omap44xx()) {
-			__raw_writel(0xffffffff, bank->base +
-					OMAP4_GPIO_IRQSTATUSCLR0);
-			__raw_writel(0x00000000, bank->base +
-					 OMAP4_GPIO_DEBOUNCENABLE);
-			/* Initialize interface clk ungated, module enabled */
-			__raw_writel(0, bank->base + OMAP4_GPIO_CTRL);
-		} else if (cpu_is_omap34xx()) {
-			__raw_writel(0x00000000, bank->base +
-					OMAP24XX_GPIO_IRQENABLE1);
-			__raw_writel(0xffffffff, bank->base +
-					OMAP24XX_GPIO_IRQSTATUS1);
-			__raw_writel(0x00000000, bank->base +
-					OMAP24XX_GPIO_DEBOUNCE_EN);
-
-			/* Initialize interface clk ungated, module enabled */
-			__raw_writel(0, bank->base + OMAP24XX_GPIO_CTRL);
-		}
-	} else if (cpu_class_is_omap1()) {
-		if (bank_is_mpuio(bank)) {
-			__raw_writew(0xffff, bank->base +
-				OMAP_MPUIO_GPIO_MASKIT / bank->stride);
-			mpuio_init(bank);
-		}
-		if (cpu_is_omap15xx() && bank->method == METHOD_GPIO_1510) {
-			__raw_writew(0xffff, bank->base
-						+ OMAP1510_GPIO_INT_MASK);
-			__raw_writew(0x0000, bank->base
-						+ OMAP1510_GPIO_INT_STATUS);
-		}
-		if (cpu_is_omap16xx() && bank->method == METHOD_GPIO_1610) {
-			__raw_writew(0x0000, bank->base
-						+ OMAP1610_GPIO_IRQENABLE1);
-			__raw_writew(0xffff, bank->base
-						+ OMAP1610_GPIO_IRQSTATUS1);
-			__raw_writew(0x0014, bank->base
-						+ OMAP1610_GPIO_SYSCONFIG);
+	void __iomem *base = bank->base;
+	u32 l = 0xffffffff;
 
-			/*
-			 * Enable system clock for GPIO module.
-			 * The CAM_CLK_CTRL *is* really the right place.
-			 */
-			omap_writel(omap_readl(ULPD_CAM_CLK_CTRL) | 0x04,
-						ULPD_CAM_CLK_CTRL);
-		}
-		if (cpu_is_omap7xx() && bank->method == METHOD_GPIO_7XX) {
-			__raw_writel(0xffffffff, bank->base
-						+ OMAP7XX_GPIO_INT_MASK);
-			__raw_writel(0x00000000, bank->base
-						+ OMAP7XX_GPIO_INT_STATUS);
-		}
+	if (bank->width == 16)
+		l = 0xffff;
+
+	if (bank_is_mpuio(bank)) {
+		__raw_writel(l, bank->base + bank->regs->irqenable);
+		return;
 	}
+
+	_gpio_rmw(base, bank->regs->irqenable, l, bank->regs->irqenable_inv);
+	_gpio_rmw(base, bank->regs->irqstatus, l,
+					bank->regs->irqenable_inv == false);
+	_gpio_rmw(base, bank->regs->irqenable, l, bank->regs->debounce_en != 0);
+	_gpio_rmw(base, bank->regs->irqenable, l, bank->regs->ctrl != 0);
 }
 
 static __init void
@@ -1074,6 +1036,11 @@ static int __devinit omap_gpio_probe(struct platform_device *pdev)
 	pm_runtime_enable(bank->dev);
 	pm_runtime_get_sync(bank->dev);
 
+	if (bank_is_mpuio(bank)) {
+		if (bank->regs->wkup_status)
+			mpuio_init(bank);
+	}
+
 	omap_gpio_mod_init(bank);
 	omap_gpio_chip_init(bank);
 	omap_gpio_show_rev(bank);
-- 
1.7.0.4

  parent reply	other threads:[~2011-08-04 11:05 UTC|newest]

Thread overview: 104+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-08-04 11:04 [PATCH v5 00/22] gpio/omap: driver cleanup and fixes Tarun Kanti DebBarma
2011-08-04 11:04 ` Tarun Kanti DebBarma
2011-08-04 11:04 ` [PATCH v5 01/22] gpio/omap: remove dependency on gpio_bank_count Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 12:35   ` Santosh
2011-08-23 12:35     ` Santosh
2011-08-29 12:18     ` DebBarma, Tarun Kanti
2011-08-29 12:18       ` DebBarma, Tarun Kanti
2011-08-04 11:04 ` [PATCH v5 02/22] gpio/omap: use flag to identify wakeup domain Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 12:41   ` Santosh
2011-08-23 12:41     ` Santosh
2011-08-04 11:04 ` [PATCH v5 03/22] gpio/omap: make gpio_context part of gpio_bank structure Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 12:45   ` Santosh
2011-08-23 12:45     ` Santosh
2011-08-25 20:23     ` Kevin Hilman
2011-08-25 20:23       ` Kevin Hilman
2011-08-26  3:57       ` DebBarma, Tarun Kanti
2011-08-26  3:57         ` DebBarma, Tarun Kanti
2011-08-26 14:11       ` Santosh
2011-08-26 14:11         ` Santosh
2011-08-04 11:04 ` [PATCH v5 04/22] gpio/omap: fix pwrdm_post_transition call sequence Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 12:47   ` Santosh
2011-08-23 12:47     ` Santosh
2011-08-04 11:04 ` [PATCH v5 05/22] gpio/omap: handle save/restore ctx in GPIO driver Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 12:53   ` Santosh
2011-08-23 12:53     ` Santosh
2011-08-23 14:47     ` Santosh
2011-08-23 14:47       ` Santosh
2011-08-04 11:04 ` [PATCH v5 06/22] gpio/omap: make non-wakeup GPIO part of pdata Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 12:54   ` Santosh
2011-08-23 12:54     ` Santosh
2011-08-04 11:04 ` [PATCH v5 07/22] gpio/omap: avoid cpu checks during module ena/disable Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 12:57   ` Santosh
2011-08-23 12:57     ` Santosh
2011-08-04 11:04 ` [PATCH v5 08/22] gpio/omap: further cleanup using wakeup_status register Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 13:02   ` Santosh
2011-08-23 13:02     ` Santosh
2011-08-04 11:04 ` [PATCH v5 09/22] gpio/omap: cleanup omap1 related macros Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 13:04   ` Santosh
2011-08-23 13:04     ` Santosh
2011-08-04 11:04 ` [PATCH v5 10/22] gpio/omap: use level/edge detect reg offsets Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 13:08   ` Santosh
2011-08-23 13:08     ` Santosh
2011-08-04 11:04 ` [PATCH v5 11/22] gpio/omap: remove hardcoded offsets in ctxt save/restore Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 13:12   ` Santosh
2011-08-23 13:12     ` Santosh
2011-08-04 11:04 ` [PATCH v5 12/22] gpio/omap: cleanup set_gpio_triggering function Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 13:21   ` Santosh
2011-08-23 13:21     ` Santosh
2011-08-04 11:04 ` Tarun Kanti DebBarma [this message]
2011-08-04 11:04   ` [PATCH v5 13/22] gpio/omap: cleanup omap_gpio_mod_init function Tarun Kanti DebBarma
2011-08-23 13:26   ` Santosh
2011-08-23 13:26     ` Santosh
2011-08-04 11:04 ` [PATCH v5 14/22] gpio/omap: use pinctrl offset instead of macro Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 13:27   ` Santosh
2011-08-23 13:27     ` Santosh
2011-08-04 11:04 ` [PATCH v5 15/22] gpio/omap: use readl in irq_handler for all access Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 14:25   ` Santosh
2011-08-23 14:25     ` Santosh
2011-08-04 11:04 ` [PATCH v5 16/22] gpio/omap: remove bank->method & METHOD_* macros Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 14:27   ` Santosh
2011-08-23 14:27     ` Santosh
2011-08-04 11:04 ` [PATCH v5 17/22] gpio/omap: fix bankwidth for OMAP7xx MPUIO Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 14:28   ` Santosh
2011-08-23 14:28     ` Santosh
2011-08-04 11:04 ` [PATCH v5 18/22] gpio/omap: use pm-runtime framework Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 14:34   ` Santosh
2011-08-23 14:34     ` Santosh
2011-08-24  4:02     ` Rajendra Nayak
2011-08-24  4:02       ` Rajendra Nayak
2011-08-24  6:19       ` Santosh
2011-08-24  6:19         ` Santosh
2011-08-04 11:04 ` [PATCH v5 19/22] gpio/omap: optimize suspend and resume functions Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 14:35   ` Santosh
2011-08-23 14:35     ` Santosh
2011-08-04 11:04 ` [PATCH v5 20/22] gpio/omap: cleanup prepare_for_idle and resume_after_idle Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 14:40   ` Santosh
2011-08-23 14:40     ` Santosh
2011-08-04 11:04 ` [PATCH v5 21/22] gpio/omap: skip operations in runtime callbacks Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 14:41   ` Santosh
2011-08-23 14:41     ` Santosh
2011-08-04 11:04 ` [PATCH v5 22/22] gpio/omap: remove omap_gpio_save_context overhead Tarun Kanti DebBarma
2011-08-04 11:04   ` Tarun Kanti DebBarma
2011-08-23 14:42   ` Santosh
2011-08-23 14:42     ` Santosh

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1312455893-14922-14-git-send-email-tarun.kanti@ti.com \
    --to=tarun.kanti@ti.com \
    --cc=charu@ti.com \
    --cc=khilman@ti.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-omap@vger.kernel.org \
    --cc=santosh.shilimkar@ti.com \
    --cc=tony@atomide.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.