All of lore.kernel.org
 help / color / mirror / Atom feed
From: Rob Herring <robh+dt-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
To: Stephen Boyd <stephen.boyd-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>
Cc: Linux USB List
	<linux-usb-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
	"linux-arm-kernel-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org"
	<linux-arm-kernel-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org>,
	"linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org"
	<linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
	linux-arm-msm
	<linux-arm-msm-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
	Andy Gross <andy.gross-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>,
	Bjorn Andersson
	<bjorn.andersson-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>,
	Neil Armstrong
	<narmstrong-rdvid1DuHRBWk0Htik3J/w@public.gmane.org>,
	Arnd Bergmann <arnd-r2nGTMty4D4@public.gmane.org>,
	Felipe Balbi <balbi-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>,
	Peter Chen <peter.chen-3arQi8VN3Tc@public.gmane.org>,
	Greg Kroah-Hartman
	<gregkh-hQyY1W1yCW8ekmWlsbkhG0B+6BGkLq7r@public.gmane.org>,
	Heikki Krogerus
	<heikki.krogerus-VuQAYsv1563Yd54FQh9/CA@public.gmane.org>,
	"devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org"
	<devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>
Subject: Re: [PATCH v4 03/22] usb: ulpi: Support device discovery via DT
Date: Wed, 7 Sep 2016 20:12:32 -0500	[thread overview]
Message-ID: <CAL_JsqJbk2TGmASK974hO0n+Y3DmB3tbggbd9wXCNa9Ug9QdDg@mail.gmail.com> (raw)
In-Reply-To: <20160907213519.27340-4-stephen.boyd-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>

On Wed, Sep 7, 2016 at 4:35 PM, Stephen Boyd <stephen.boyd-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org> wrote:
> The qcom HSIC ULPI phy doesn't have any bits set in the vendor or
> product ID registers. This makes it impossible to make a ULPI
> driver match against the ID registers. Add support to discover
> the ULPI phys via DT help alleviate this problem. In the DT case,
> we'll look for a ULPI bus node underneath the device registering
> the ULPI viewport (or the parent of that device to support
> chipidea's device layout) and then match up the phy node
> underneath that with the ULPI device that's created.
>
> The side benefit of this is that we can use standard properties
> in the phy node like clks, regulators, gpios, etc. because we
> don't have firmware like ACPI to turn these things on for us. And
> we can use the DT phy binding to point our phy consumer to the
> phy provider.
>
> The ULPI bus code supports native enumeration by reading the
> vendor ID and product ID registers at device creation time, but
> we can't be certain that those register reads will succeed if the
> phy is not powered up. To avoid any problems with reading the ID
> registers before the phy is powered we fallback to DT matching
> when the ID reads fail.
>
> If the ULPI spec had some generic power sequencing for these
> registers we could put that into the ULPI bus layer and power up
> the device before reading the ID registers. Unfortunately this
> doesn't exist and the power sequence is usually device specific.
> By having the device matched up with DT we can avoid this
> problem.
>
> Cc: Greg Kroah-Hartman <gregkh-hQyY1W1yCW8ekmWlsbkhG0B+6BGkLq7r@public.gmane.org>
> Cc: Heikki Krogerus <heikki.krogerus-VuQAYsv1563Yd54FQh9/CA@public.gmane.org>
> Cc: <devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>
> Cc: Rob Herring <robh+dt-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
> Signed-off-by: Stephen Boyd <stephen.boyd-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>
> ---
>  Documentation/devicetree/bindings/usb/ulpi.txt | 20 +++++++
>  drivers/usb/common/ulpi.c                      | 77 ++++++++++++++++++++++++--
>  2 files changed, 92 insertions(+), 5 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/usb/ulpi.txt

Acked-by: Rob Herring <robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>

But one concern below.

> -static int ulpi_register(struct device *dev, struct ulpi *ulpi)
> +static int ulpi_of_register(struct ulpi *ulpi)
> +{
> +       struct device_node *np = NULL, *child;
> +
> +       /* Find a ulpi bus underneath the parent or the parent of the parent */

parent of the parent is called the grandparent.

> +       if (ulpi->dev.parent->of_node)
> +               np = of_find_node_by_name(ulpi->dev.parent->of_node, "ulpi");
> +       else if (ulpi->dev.parent->parent && ulpi->dev.parent->parent->of_node)
> +               np = of_find_node_by_name(ulpi->dev.parent->parent->of_node,

First setting "parent = ulpi->dev.parent" would make this a bit easier
on the eyes.

When is it valid to be the grandparent? The binding doesn't mention that.

Rob
--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

WARNING: multiple messages have this Message-ID (diff)
From: Rob Herring <robh+dt@kernel.org>
To: Stephen Boyd <stephen.boyd@linaro.org>
Cc: Linux USB List <linux-usb@vger.kernel.org>,
	"linux-arm-kernel@lists.infradead.org" 
	<linux-arm-kernel@lists.infradead.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	linux-arm-msm <linux-arm-msm@vger.kernel.org>,
	Andy Gross <andy.gross@linaro.org>,
	Bjorn Andersson <bjorn.andersson@linaro.org>,
	Neil Armstrong <narmstrong@baylibre.com>,
	Arnd Bergmann <arnd@arndb.de>, Felipe Balbi <balbi@kernel.org>,
	Peter Chen <peter.chen@nxp.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Heikki Krogerus <heikki.krogerus@linux.intel.com>,
	"devicetree@vger.kernel.org" <devicetree@vger.kernel.org>
Subject: Re: [PATCH v4 03/22] usb: ulpi: Support device discovery via DT
Date: Wed, 7 Sep 2016 20:12:32 -0500	[thread overview]
Message-ID: <CAL_JsqJbk2TGmASK974hO0n+Y3DmB3tbggbd9wXCNa9Ug9QdDg@mail.gmail.com> (raw)
In-Reply-To: <20160907213519.27340-4-stephen.boyd@linaro.org>

On Wed, Sep 7, 2016 at 4:35 PM, Stephen Boyd <stephen.boyd@linaro.org> wrote:
> The qcom HSIC ULPI phy doesn't have any bits set in the vendor or
> product ID registers. This makes it impossible to make a ULPI
> driver match against the ID registers. Add support to discover
> the ULPI phys via DT help alleviate this problem. In the DT case,
> we'll look for a ULPI bus node underneath the device registering
> the ULPI viewport (or the parent of that device to support
> chipidea's device layout) and then match up the phy node
> underneath that with the ULPI device that's created.
>
> The side benefit of this is that we can use standard properties
> in the phy node like clks, regulators, gpios, etc. because we
> don't have firmware like ACPI to turn these things on for us. And
> we can use the DT phy binding to point our phy consumer to the
> phy provider.
>
> The ULPI bus code supports native enumeration by reading the
> vendor ID and product ID registers at device creation time, but
> we can't be certain that those register reads will succeed if the
> phy is not powered up. To avoid any problems with reading the ID
> registers before the phy is powered we fallback to DT matching
> when the ID reads fail.
>
> If the ULPI spec had some generic power sequencing for these
> registers we could put that into the ULPI bus layer and power up
> the device before reading the ID registers. Unfortunately this
> doesn't exist and the power sequence is usually device specific.
> By having the device matched up with DT we can avoid this
> problem.
>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: Heikki Krogerus <heikki.krogerus@linux.intel.com>
> Cc: <devicetree@vger.kernel.org>
> Cc: Rob Herring <robh+dt@kernel.org>
> Signed-off-by: Stephen Boyd <stephen.boyd@linaro.org>
> ---
>  Documentation/devicetree/bindings/usb/ulpi.txt | 20 +++++++
>  drivers/usb/common/ulpi.c                      | 77 ++++++++++++++++++++++++--
>  2 files changed, 92 insertions(+), 5 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/usb/ulpi.txt

Acked-by: Rob Herring <robh@kernel.org>

But one concern below.

> -static int ulpi_register(struct device *dev, struct ulpi *ulpi)
> +static int ulpi_of_register(struct ulpi *ulpi)
> +{
> +       struct device_node *np = NULL, *child;
> +
> +       /* Find a ulpi bus underneath the parent or the parent of the parent */

parent of the parent is called the grandparent.

> +       if (ulpi->dev.parent->of_node)
> +               np = of_find_node_by_name(ulpi->dev.parent->of_node, "ulpi");
> +       else if (ulpi->dev.parent->parent && ulpi->dev.parent->parent->of_node)
> +               np = of_find_node_by_name(ulpi->dev.parent->parent->of_node,

First setting "parent = ulpi->dev.parent" would make this a bit easier
on the eyes.

When is it valid to be the grandparent? The binding doesn't mention that.

Rob

WARNING: multiple messages have this Message-ID (diff)
From: robh+dt@kernel.org (Rob Herring)
To: linux-arm-kernel@lists.infradead.org
Subject: [PATCH v4 03/22] usb: ulpi: Support device discovery via DT
Date: Wed, 7 Sep 2016 20:12:32 -0500	[thread overview]
Message-ID: <CAL_JsqJbk2TGmASK974hO0n+Y3DmB3tbggbd9wXCNa9Ug9QdDg@mail.gmail.com> (raw)
In-Reply-To: <20160907213519.27340-4-stephen.boyd@linaro.org>

On Wed, Sep 7, 2016 at 4:35 PM, Stephen Boyd <stephen.boyd@linaro.org> wrote:
> The qcom HSIC ULPI phy doesn't have any bits set in the vendor or
> product ID registers. This makes it impossible to make a ULPI
> driver match against the ID registers. Add support to discover
> the ULPI phys via DT help alleviate this problem. In the DT case,
> we'll look for a ULPI bus node underneath the device registering
> the ULPI viewport (or the parent of that device to support
> chipidea's device layout) and then match up the phy node
> underneath that with the ULPI device that's created.
>
> The side benefit of this is that we can use standard properties
> in the phy node like clks, regulators, gpios, etc. because we
> don't have firmware like ACPI to turn these things on for us. And
> we can use the DT phy binding to point our phy consumer to the
> phy provider.
>
> The ULPI bus code supports native enumeration by reading the
> vendor ID and product ID registers at device creation time, but
> we can't be certain that those register reads will succeed if the
> phy is not powered up. To avoid any problems with reading the ID
> registers before the phy is powered we fallback to DT matching
> when the ID reads fail.
>
> If the ULPI spec had some generic power sequencing for these
> registers we could put that into the ULPI bus layer and power up
> the device before reading the ID registers. Unfortunately this
> doesn't exist and the power sequence is usually device specific.
> By having the device matched up with DT we can avoid this
> problem.
>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: Heikki Krogerus <heikki.krogerus@linux.intel.com>
> Cc: <devicetree@vger.kernel.org>
> Cc: Rob Herring <robh+dt@kernel.org>
> Signed-off-by: Stephen Boyd <stephen.boyd@linaro.org>
> ---
>  Documentation/devicetree/bindings/usb/ulpi.txt | 20 +++++++
>  drivers/usb/common/ulpi.c                      | 77 ++++++++++++++++++++++++--
>  2 files changed, 92 insertions(+), 5 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/usb/ulpi.txt

Acked-by: Rob Herring <robh@kernel.org>

But one concern below.

> -static int ulpi_register(struct device *dev, struct ulpi *ulpi)
> +static int ulpi_of_register(struct ulpi *ulpi)
> +{
> +       struct device_node *np = NULL, *child;
> +
> +       /* Find a ulpi bus underneath the parent or the parent of the parent */

parent of the parent is called the grandparent.

> +       if (ulpi->dev.parent->of_node)
> +               np = of_find_node_by_name(ulpi->dev.parent->of_node, "ulpi");
> +       else if (ulpi->dev.parent->parent && ulpi->dev.parent->parent->of_node)
> +               np = of_find_node_by_name(ulpi->dev.parent->parent->of_node,

First setting "parent = ulpi->dev.parent" would make this a bit easier
on the eyes.

When is it valid to be the grandparent? The binding doesn't mention that.

Rob

  parent reply	other threads:[~2016-09-08  1:12 UTC|newest]

Thread overview: 109+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-07 21:34 [PATCH v4 00/22] Support qcom's HSIC USB and rewrite USB2 HS support Stephen Boyd
2016-09-07 21:34 ` Stephen Boyd
2016-09-07 21:34 ` [PATCH v4 02/22] of: device: Export of_device_{get_modalias, uvent_modalias} to modules Stephen Boyd
2016-09-07 21:34   ` Stephen Boyd
2016-09-07 21:34   ` [PATCH v4 02/22] of: device: Export of_device_{get_modalias,uvent_modalias} " Stephen Boyd
2016-09-08  0:58   ` Rob Herring
2016-09-08  0:58     ` [PATCH v4 02/22] of: device: Export of_device_{get_modalias, uvent_modalias} " Rob Herring
2016-09-08  0:58     ` [PATCH v4 02/22] of: device: Export of_device_{get_modalias,uvent_modalias} " Rob Herring
2016-09-07 21:35 ` [PATCH v4 03/22] usb: ulpi: Support device discovery via DT Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
     [not found]   ` <20160907213519.27340-4-stephen.boyd-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>
2016-09-08  1:12     ` Rob Herring [this message]
2016-09-08  1:12       ` Rob Herring
2016-09-08  1:12       ` Rob Herring
2016-09-08  1:54       ` Stephen Boyd
2016-09-08  1:54         ` Stephen Boyd
2016-09-12 22:05     ` Stephen Boyd
2016-09-12 22:05       ` Stephen Boyd
2016-09-12 22:05       ` Stephen Boyd
2016-09-07 21:35 ` [PATCH v4 04/22] usb: chipidea: Only read/write OTGSC from one place Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
2016-09-07 21:35 ` [PATCH v4 05/22] usb: chipidea: Handle extcon events properly Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
2016-09-07 21:35 ` [PATCH v4 06/22] usb: chipidea: Add platform flag for wrapper phy management Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
2016-09-07 21:35 ` [PATCH v4 07/22] usb: chipidea: Notify events when switching host mode Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
2016-09-07 21:35 ` [PATCH v4 08/22] usb: chipidea: Remove locking in ci_udc_start() Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
2016-09-07 21:35 ` [PATCH v4 09/22] usb: chipidea: Add support for ULPI PHY bus Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
2016-09-07 21:35 ` [PATCH v4 10/22] usb: chipidea: Consolidate extcon notifiers Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
2016-09-08  1:23   ` Peter Chen
2016-09-08  1:23     ` Peter Chen
2016-09-07 21:35 ` [PATCH v4 12/22] usb: chipidea: msm: Rely on core to override AHBBURST Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
2016-09-07 21:35 ` [PATCH v4 15/22] usb: chipidea: msm: Mux over secondary phy at the right time Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
2016-09-07 21:35 ` [PATCH v4 18/22] usb: chipidea: msm: Add reset controller for PHY POR bit Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
2016-09-07 21:35 ` [PATCH v4 19/22] usb: chipidea: msm: Handle phy power states Stephen Boyd
2016-09-07 21:35   ` Stephen Boyd
     [not found] ` <20160907213519.27340-1-stephen.boyd-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>
2016-09-07 21:34   ` [PATCH v4 01/22] of: device: Support loading a module with OF based modalias Stephen Boyd
2016-09-07 21:34     ` Stephen Boyd
2016-09-07 21:34     ` Stephen Boyd
2016-09-08  0:58     ` Rob Herring
2016-09-08  0:58       ` Rob Herring
2016-09-08  0:58       ` Rob Herring
2016-09-07 21:35   ` [PATCH v4 11/22] usb: chipidea: msm: Mark device as runtime pm active Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35   ` [PATCH v4 13/22] usb: chipidea: msm: Use hw_write_id_reg() instead of writel Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35   ` [PATCH v4 14/22] usb: chipidea: msm: Add proper clk and reset support Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35   ` [PATCH v4 16/22] usb: chipidea: msm: Restore wrapper settings after reset Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35   ` [PATCH v4 17/22] usb: chipidea: msm: Make platform data driver local instead of global Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35   ` [PATCH v4 20/22] usb: chipidea: msm: Be silent on probe defer errors Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35   ` [PATCH v4 21/22] phy: Add support for Qualcomm's USB HSIC phy Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-16 14:21     ` Rob Herring
2016-09-16 14:21       ` Rob Herring
2016-09-07 21:35   ` [PATCH v4 22/22] phy: Add support for Qualcomm's USB HS phy Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-07 21:35     ` Stephen Boyd
2016-09-13  7:03     ` Peter Chen
2016-09-13  7:03       ` Peter Chen
2016-09-13 20:41       ` Stephen Boyd
2016-09-13 20:41         ` Stephen Boyd
2016-09-14  2:11         ` Peter Chen
2016-09-14  2:11           ` Peter Chen
2016-09-14  2:11           ` Peter Chen
2016-09-14  6:29           ` Stephen Boyd
2016-09-14  6:29             ` Stephen Boyd
2016-09-14  9:33             ` Peter Chen
2016-09-14  9:33               ` Peter Chen
2016-09-14 17:42               ` Stephen Boyd
2016-09-14 17:42                 ` Stephen Boyd
2016-09-15  5:29                 ` Peter Chen
2016-09-15  5:29                   ` Peter Chen
     [not found]     ` <20160910121857.GB11271@a0393678ub>
2016-09-14  5:29       ` Kishon Vijay Abraham I
2016-09-14  5:29         ` Kishon Vijay Abraham I
2016-09-14  5:29         ` Kishon Vijay Abraham I
2016-09-16 15:19     ` Rob Herring
2016-09-16 15:19       ` Rob Herring
2016-09-17  0:05       ` Stephen Boyd
2016-09-17  0:05         ` Stephen Boyd
2016-09-19 21:01         ` Rob Herring
2016-09-19 21:01           ` Rob Herring
2016-09-19 21:01           ` Rob Herring
2016-09-08  2:06   ` [PATCH v4 00/22] Support qcom's HSIC USB and rewrite USB2 HS support Peter Chen
2016-09-08  2:06     ` Peter Chen
2016-09-08  2:06     ` Peter Chen
2016-09-08 21:13     ` Stephen Boyd
2016-09-08 21:13       ` Stephen Boyd
2016-09-09  0:45       ` Peter Chen
2016-09-09  0:45         ` Peter Chen
2016-09-09  0:45         ` Peter Chen

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=CAL_JsqJbk2TGmASK974hO0n+Y3DmB3tbggbd9wXCNa9Ug9QdDg@mail.gmail.com \
    --to=robh+dt-dgejt+ai2ygdnm+yrofe0a@public.gmane.org \
    --cc=andy.gross-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org \
    --cc=arnd-r2nGTMty4D4@public.gmane.org \
    --cc=balbi-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org \
    --cc=bjorn.andersson-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org \
    --cc=devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=gregkh-hQyY1W1yCW8ekmWlsbkhG0B+6BGkLq7r@public.gmane.org \
    --cc=heikki.krogerus-VuQAYsv1563Yd54FQh9/CA@public.gmane.org \
    --cc=linux-arm-kernel-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org \
    --cc=linux-arm-msm-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=linux-usb-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=narmstrong-rdvid1DuHRBWk0Htik3J/w@public.gmane.org \
    --cc=peter.chen-3arQi8VN3Tc@public.gmane.org \
    --cc=stephen.boyd-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org \
    /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.