All of lore.kernel.org
 help / color / mirror / Atom feed
From: Tony Prisk <linux@prisktech.co.nz>
To: dwmw2@infradead.org
Cc: dedekind1@gmail.com, linux-kernel@vger.kernel.org,
	Tony Prisk <linux@prisktech.co.nz>,
	linux-mtd@lists.infradead.org,
	vt8500-wm8505-linux-kernel@googlegroups.com,
	linux-arm-kernel@lists.infradead.org
Subject: [PATCH v3 1/2] mtd: Add a common JEDEC flash device table
Date: Wed, 23 Jan 2013 21:01:07 +1300	[thread overview]
Message-ID: <1358928068-12417-2-git-send-email-linux@prisktech.co.nz> (raw)
In-Reply-To: <1358928068-12417-1-git-send-email-linux@prisktech.co.nz>

This patch adds a common JEDEC flash device table which can be
expanded on as more features are required.

A simple match function is also included to query the table for
a match based on the JEDEC id.

Signed-off-by: Tony Prisk <linux@prisktech.co.nz>
---
 drivers/mtd/devices/flash_jedec.c |   96 +++++++++++++++++++++++++++++++++++++
 drivers/mtd/devices/flash_jedec.h |   30 ++++++++++++
 2 files changed, 126 insertions(+)
 create mode 100644 drivers/mtd/devices/flash_jedec.c
 create mode 100644 drivers/mtd/devices/flash_jedec.h

diff --git a/drivers/mtd/devices/flash_jedec.c b/drivers/mtd/devices/flash_jedec.c
new file mode 100644
index 0000000..c0b2272
--- /dev/null
+++ b/drivers/mtd/devices/flash_jedec.c
@@ -0,0 +1,96 @@
+/*
+ * Copyright Tony Prisk <linux@prisktech.co.nz>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include <linux/bug.h>
+#include <linux/err.h>
+#include <linux/kernel.h>
+#include <linux/types.h>
+
+#include "flash_jedec.h"
+
+/*
+ * Device Manufacturer IDs
+ * Please keep sorted by manufacturer ID
+ */
+#define MFR_SPANSION		0X01
+#define MFR_EON			0X1C
+#define MFR_ATMEL		0X1F
+#define MFR_MICRON		0X20	/* Also Numonyx & STM */
+#define MFR_INTEL		0x89
+#define MFR_FUDAN		0XA1
+#define MFR_SST			0XBF
+#define MFR_MXIC		0XC2
+#define MFR_WINBOND		0XEF
+
+#define _ID(m, d)	((m << 16) | d)
+
+/*
+ * Flash device information
+ * Please keep sorted by manufacturer id, then device id
+ */
+static struct flash_device_info flash_devices[] = {
+	/* Spansion */
+	{ "s25fl016", _ID(MFR_SPANSION, 0x0214), 2048 },
+	{ "s25fl064", _ID(MFR_SPANSION, 0x0216), 8192 },
+	/* EON */
+	{ "en25p16", _ID(MFR_EON, 0x2015), 2048 },
+	{ "en25p64", _ID(MFR_EON, 0x2017), 8192 },
+	{ "en25f40", _ID(MFR_EON, 0x3113),  512 },
+	{ "en25f16", _ID(MFR_EON, 0x3115), 2048 },
+	/* ATMEL */
+	{ "at25df041a", _ID(MFR_ATMEL, 0x4401), 512 },
+	/* Micron, STM & Numonyx */
+	{ "stm25p16", _ID(MFR_MICRON, 0x2015), 2048 },
+	{ "stm25p64", _ID(MFR_MICRON, 0x2017), 8192 },
+	/* Fudan */
+	{ "fm25f04", _ID(MFR_FUDAN, 0x3113), 512 },
+	/* SST */
+	{ "sst25vf016b", _ID(MFR_SST, 0x2541), 2048 },
+	/* Macronix - MXIC */
+	{ "mx25l512",   _ID(MFR_MXIC, 0x2010),    64 },
+	{ "mx25l4005",  _ID(MFR_MXIC, 0x2013),   512 },
+	{ "mx25l1605",  _ID(MFR_MXIC, 0x2015),  2048 },
+	{ "mx25l3205",  _ID(MFR_MXIC, 0x2016),  4096 },
+	{ "mx25l6405",  _ID(MFR_MXIC, 0x2017),  8192 },
+	{ "mx25l12805", _ID(MFR_MXIC, 0x2018), 16384 },
+	{ "mx25l1635",  _ID(MFR_MXIC, 0x2415),  2048 },
+	{ "mx25l3235",  _ID(MFR_MXIC, 0x5E16),  4096 },
+	/* Winbond */
+	{ "w25x40", _ID(MFR_WINBOND, 0x3013),   512 },
+	{ "w25x16", _ID(MFR_WINBOND, 0x3015),  2048 },
+	{ "w25x32", _ID(MFR_WINBOND, 0x3016),  4096 },
+	{ "w25x64", _ID(MFR_WINBOND, 0x3017),  8192 },
+};
+
+/*
+ * jedec_match_device - match a jedec id against the flash_devices table
+ * @jedecid: JEDEC formatted id to match
+ *	bits 16..24: manufacturer id
+ *	bits  0..15: device id
+ * Returns a valid flash_device_info* or ERR_PTR(-ENODEV) if an entry is
+ * not found
+ */
+struct flash_device_info *jedec_match_device(u32 jedec_id)
+{
+	int i;
+	for (i = 0; i < ARRAY_SIZE(flash_devices); i++)
+		if (flash_devices[i].jedec_id == jedec_id)
+			return &flash_devices[i];
+
+	return ERR_PTR(-ENODEV);
+}
diff --git a/drivers/mtd/devices/flash_jedec.h b/drivers/mtd/devices/flash_jedec.h
new file mode 100644
index 0000000..27b978a
--- /dev/null
+++ b/drivers/mtd/devices/flash_jedec.h
@@ -0,0 +1,30 @@
+/*
+ * Copyright Tony Prisk <linux@prisktech.co.nz>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#ifndef __MTD_FLASH_JEDEC
+#define __MTD_FLASH_JEDEC
+
+struct flash_device_info {
+	const char	*name;
+	u32		jedec_id;
+	u32		size_kb;
+};
+
+extern struct flash_device_info *jedec_match_device(u32 jedec_id);
+
+#endif
-- 
1.7.9.5

WARNING: multiple messages have this Message-ID (diff)
From: linux@prisktech.co.nz (Tony Prisk)
To: linux-arm-kernel@lists.infradead.org
Subject: [PATCH v3 1/2] mtd: Add a common JEDEC flash device table
Date: Wed, 23 Jan 2013 21:01:07 +1300	[thread overview]
Message-ID: <1358928068-12417-2-git-send-email-linux@prisktech.co.nz> (raw)
In-Reply-To: <1358928068-12417-1-git-send-email-linux@prisktech.co.nz>

This patch adds a common JEDEC flash device table which can be
expanded on as more features are required.

A simple match function is also included to query the table for
a match based on the JEDEC id.

Signed-off-by: Tony Prisk <linux@prisktech.co.nz>
---
 drivers/mtd/devices/flash_jedec.c |   96 +++++++++++++++++++++++++++++++++++++
 drivers/mtd/devices/flash_jedec.h |   30 ++++++++++++
 2 files changed, 126 insertions(+)
 create mode 100644 drivers/mtd/devices/flash_jedec.c
 create mode 100644 drivers/mtd/devices/flash_jedec.h

diff --git a/drivers/mtd/devices/flash_jedec.c b/drivers/mtd/devices/flash_jedec.c
new file mode 100644
index 0000000..c0b2272
--- /dev/null
+++ b/drivers/mtd/devices/flash_jedec.c
@@ -0,0 +1,96 @@
+/*
+ * Copyright Tony Prisk <linux@prisktech.co.nz>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include <linux/bug.h>
+#include <linux/err.h>
+#include <linux/kernel.h>
+#include <linux/types.h>
+
+#include "flash_jedec.h"
+
+/*
+ * Device Manufacturer IDs
+ * Please keep sorted by manufacturer ID
+ */
+#define MFR_SPANSION		0X01
+#define MFR_EON			0X1C
+#define MFR_ATMEL		0X1F
+#define MFR_MICRON		0X20	/* Also Numonyx & STM */
+#define MFR_INTEL		0x89
+#define MFR_FUDAN		0XA1
+#define MFR_SST			0XBF
+#define MFR_MXIC		0XC2
+#define MFR_WINBOND		0XEF
+
+#define _ID(m, d)	((m << 16) | d)
+
+/*
+ * Flash device information
+ * Please keep sorted by manufacturer id, then device id
+ */
+static struct flash_device_info flash_devices[] = {
+	/* Spansion */
+	{ "s25fl016", _ID(MFR_SPANSION, 0x0214), 2048 },
+	{ "s25fl064", _ID(MFR_SPANSION, 0x0216), 8192 },
+	/* EON */
+	{ "en25p16", _ID(MFR_EON, 0x2015), 2048 },
+	{ "en25p64", _ID(MFR_EON, 0x2017), 8192 },
+	{ "en25f40", _ID(MFR_EON, 0x3113),  512 },
+	{ "en25f16", _ID(MFR_EON, 0x3115), 2048 },
+	/* ATMEL */
+	{ "at25df041a", _ID(MFR_ATMEL, 0x4401), 512 },
+	/* Micron, STM & Numonyx */
+	{ "stm25p16", _ID(MFR_MICRON, 0x2015), 2048 },
+	{ "stm25p64", _ID(MFR_MICRON, 0x2017), 8192 },
+	/* Fudan */
+	{ "fm25f04", _ID(MFR_FUDAN, 0x3113), 512 },
+	/* SST */
+	{ "sst25vf016b", _ID(MFR_SST, 0x2541), 2048 },
+	/* Macronix - MXIC */
+	{ "mx25l512",   _ID(MFR_MXIC, 0x2010),    64 },
+	{ "mx25l4005",  _ID(MFR_MXIC, 0x2013),   512 },
+	{ "mx25l1605",  _ID(MFR_MXIC, 0x2015),  2048 },
+	{ "mx25l3205",  _ID(MFR_MXIC, 0x2016),  4096 },
+	{ "mx25l6405",  _ID(MFR_MXIC, 0x2017),  8192 },
+	{ "mx25l12805", _ID(MFR_MXIC, 0x2018), 16384 },
+	{ "mx25l1635",  _ID(MFR_MXIC, 0x2415),  2048 },
+	{ "mx25l3235",  _ID(MFR_MXIC, 0x5E16),  4096 },
+	/* Winbond */
+	{ "w25x40", _ID(MFR_WINBOND, 0x3013),   512 },
+	{ "w25x16", _ID(MFR_WINBOND, 0x3015),  2048 },
+	{ "w25x32", _ID(MFR_WINBOND, 0x3016),  4096 },
+	{ "w25x64", _ID(MFR_WINBOND, 0x3017),  8192 },
+};
+
+/*
+ * jedec_match_device - match a jedec id against the flash_devices table
+ * @jedecid: JEDEC formatted id to match
+ *	bits 16..24: manufacturer id
+ *	bits  0..15: device id
+ * Returns a valid flash_device_info* or ERR_PTR(-ENODEV) if an entry is
+ * not found
+ */
+struct flash_device_info *jedec_match_device(u32 jedec_id)
+{
+	int i;
+	for (i = 0; i < ARRAY_SIZE(flash_devices); i++)
+		if (flash_devices[i].jedec_id == jedec_id)
+			return &flash_devices[i];
+
+	return ERR_PTR(-ENODEV);
+}
diff --git a/drivers/mtd/devices/flash_jedec.h b/drivers/mtd/devices/flash_jedec.h
new file mode 100644
index 0000000..27b978a
--- /dev/null
+++ b/drivers/mtd/devices/flash_jedec.h
@@ -0,0 +1,30 @@
+/*
+ * Copyright Tony Prisk <linux@prisktech.co.nz>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#ifndef __MTD_FLASH_JEDEC
+#define __MTD_FLASH_JEDEC
+
+struct flash_device_info {
+	const char	*name;
+	u32		jedec_id;
+	u32		size_kb;
+};
+
+extern struct flash_device_info *jedec_match_device(u32 jedec_id);
+
+#endif
-- 
1.7.9.5

WARNING: multiple messages have this Message-ID (diff)
From: Tony Prisk <linux@prisktech.co.nz>
To: dwmw2@infradead.org
Cc: linux-kernel@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	vt8500-wm8505-linux-kernel@googlegroups.com,
	linux-mtd@lists.infradead.org, dedekind1@gmail.com,
	Tony Prisk <linux@prisktech.co.nz>
Subject: [PATCH v3 1/2] mtd: Add a common JEDEC flash device table
Date: Wed, 23 Jan 2013 21:01:07 +1300	[thread overview]
Message-ID: <1358928068-12417-2-git-send-email-linux@prisktech.co.nz> (raw)
In-Reply-To: <1358928068-12417-1-git-send-email-linux@prisktech.co.nz>

This patch adds a common JEDEC flash device table which can be
expanded on as more features are required.

A simple match function is also included to query the table for
a match based on the JEDEC id.

Signed-off-by: Tony Prisk <linux@prisktech.co.nz>
---
 drivers/mtd/devices/flash_jedec.c |   96 +++++++++++++++++++++++++++++++++++++
 drivers/mtd/devices/flash_jedec.h |   30 ++++++++++++
 2 files changed, 126 insertions(+)
 create mode 100644 drivers/mtd/devices/flash_jedec.c
 create mode 100644 drivers/mtd/devices/flash_jedec.h

diff --git a/drivers/mtd/devices/flash_jedec.c b/drivers/mtd/devices/flash_jedec.c
new file mode 100644
index 0000000..c0b2272
--- /dev/null
+++ b/drivers/mtd/devices/flash_jedec.c
@@ -0,0 +1,96 @@
+/*
+ * Copyright Tony Prisk <linux@prisktech.co.nz>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include <linux/bug.h>
+#include <linux/err.h>
+#include <linux/kernel.h>
+#include <linux/types.h>
+
+#include "flash_jedec.h"
+
+/*
+ * Device Manufacturer IDs
+ * Please keep sorted by manufacturer ID
+ */
+#define MFR_SPANSION		0X01
+#define MFR_EON			0X1C
+#define MFR_ATMEL		0X1F
+#define MFR_MICRON		0X20	/* Also Numonyx & STM */
+#define MFR_INTEL		0x89
+#define MFR_FUDAN		0XA1
+#define MFR_SST			0XBF
+#define MFR_MXIC		0XC2
+#define MFR_WINBOND		0XEF
+
+#define _ID(m, d)	((m << 16) | d)
+
+/*
+ * Flash device information
+ * Please keep sorted by manufacturer id, then device id
+ */
+static struct flash_device_info flash_devices[] = {
+	/* Spansion */
+	{ "s25fl016", _ID(MFR_SPANSION, 0x0214), 2048 },
+	{ "s25fl064", _ID(MFR_SPANSION, 0x0216), 8192 },
+	/* EON */
+	{ "en25p16", _ID(MFR_EON, 0x2015), 2048 },
+	{ "en25p64", _ID(MFR_EON, 0x2017), 8192 },
+	{ "en25f40", _ID(MFR_EON, 0x3113),  512 },
+	{ "en25f16", _ID(MFR_EON, 0x3115), 2048 },
+	/* ATMEL */
+	{ "at25df041a", _ID(MFR_ATMEL, 0x4401), 512 },
+	/* Micron, STM & Numonyx */
+	{ "stm25p16", _ID(MFR_MICRON, 0x2015), 2048 },
+	{ "stm25p64", _ID(MFR_MICRON, 0x2017), 8192 },
+	/* Fudan */
+	{ "fm25f04", _ID(MFR_FUDAN, 0x3113), 512 },
+	/* SST */
+	{ "sst25vf016b", _ID(MFR_SST, 0x2541), 2048 },
+	/* Macronix - MXIC */
+	{ "mx25l512",   _ID(MFR_MXIC, 0x2010),    64 },
+	{ "mx25l4005",  _ID(MFR_MXIC, 0x2013),   512 },
+	{ "mx25l1605",  _ID(MFR_MXIC, 0x2015),  2048 },
+	{ "mx25l3205",  _ID(MFR_MXIC, 0x2016),  4096 },
+	{ "mx25l6405",  _ID(MFR_MXIC, 0x2017),  8192 },
+	{ "mx25l12805", _ID(MFR_MXIC, 0x2018), 16384 },
+	{ "mx25l1635",  _ID(MFR_MXIC, 0x2415),  2048 },
+	{ "mx25l3235",  _ID(MFR_MXIC, 0x5E16),  4096 },
+	/* Winbond */
+	{ "w25x40", _ID(MFR_WINBOND, 0x3013),   512 },
+	{ "w25x16", _ID(MFR_WINBOND, 0x3015),  2048 },
+	{ "w25x32", _ID(MFR_WINBOND, 0x3016),  4096 },
+	{ "w25x64", _ID(MFR_WINBOND, 0x3017),  8192 },
+};
+
+/*
+ * jedec_match_device - match a jedec id against the flash_devices table
+ * @jedecid: JEDEC formatted id to match
+ *	bits 16..24: manufacturer id
+ *	bits  0..15: device id
+ * Returns a valid flash_device_info* or ERR_PTR(-ENODEV) if an entry is
+ * not found
+ */
+struct flash_device_info *jedec_match_device(u32 jedec_id)
+{
+	int i;
+	for (i = 0; i < ARRAY_SIZE(flash_devices); i++)
+		if (flash_devices[i].jedec_id == jedec_id)
+			return &flash_devices[i];
+
+	return ERR_PTR(-ENODEV);
+}
diff --git a/drivers/mtd/devices/flash_jedec.h b/drivers/mtd/devices/flash_jedec.h
new file mode 100644
index 0000000..27b978a
--- /dev/null
+++ b/drivers/mtd/devices/flash_jedec.h
@@ -0,0 +1,30 @@
+/*
+ * Copyright Tony Prisk <linux@prisktech.co.nz>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#ifndef __MTD_FLASH_JEDEC
+#define __MTD_FLASH_JEDEC
+
+struct flash_device_info {
+	const char	*name;
+	u32		jedec_id;
+	u32		size_kb;
+};
+
+extern struct flash_device_info *jedec_match_device(u32 jedec_id);
+
+#endif
-- 
1.7.9.5


  reply	other threads:[~2013-01-23  8:01 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-01-23  8:01 [PATCH v3 0/2] Add Wondermedia Serial Flash controller support Tony Prisk
2013-01-23  8:01 ` Tony Prisk
2013-01-23  8:01 ` Tony Prisk
2013-01-23  8:01 ` Tony Prisk [this message]
2013-01-23  8:01   ` [PATCH v3 1/2] mtd: Add a common JEDEC flash device table Tony Prisk
2013-01-23  8:01   ` Tony Prisk
2013-01-23  9:00   ` Matthieu CASTET
2013-01-23  9:00     ` Matthieu CASTET
2013-01-23  9:00     ` Matthieu CASTET
2013-01-23 18:28     ` Tony Prisk
2013-01-23 18:28       ` Tony Prisk
2013-01-23 18:28       ` Tony Prisk
2013-01-23  8:01 ` [PATCH v3 2/2] mtd: vt8500: Add support for Wondermedia Serial Flash Controller Tony Prisk
2013-01-23  8:01   ` Tony Prisk
2013-01-23  8:01   ` Tony Prisk

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=1358928068-12417-2-git-send-email-linux@prisktech.co.nz \
    --to=linux@prisktech.co.nz \
    --cc=dedekind1@gmail.com \
    --cc=dwmw2@infradead.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mtd@lists.infradead.org \
    --cc=vt8500-wm8505-linux-kernel@googlegroups.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.