All of lore.kernel.org
 help / color / mirror / Atom feed
* Query related to MSR(Magnetic Stripe Reader) Device Driver
@ 2013-01-22  9:32 Priyaranjan Das
  2013-01-22 16:36 ` Greg KH
  0 siblings, 1 reply; 10+ messages in thread
From: Priyaranjan Das @ 2013-01-22  9:32 UTC (permalink / raw)
  To: linux-kernel

Hi All,

I am working on MSR(Magnetic Stripe Reader) for a product . I wish to
know whether any MSR( Magnetic Stripe/card Reader) driver is available
in the current source or not. I need this for reference. Could anyone
please help me?


Regards,
Priyaranjan

^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: Query related to MSR(Magnetic Stripe Reader) Device Driver
  2013-01-22  9:32 Query related to MSR(Magnetic Stripe Reader) Device Driver Priyaranjan Das
@ 2013-01-22 16:36 ` Greg KH
  2013-01-28  9:55   ` Priyaranjan Das
  0 siblings, 1 reply; 10+ messages in thread
From: Greg KH @ 2013-01-22 16:36 UTC (permalink / raw)
  To: Priyaranjan Das; +Cc: linux-kernel

On Tue, Jan 22, 2013 at 03:02:32PM +0530, Priyaranjan Das wrote:
> Hi All,
> 
> I am working on MSR(Magnetic Stripe Reader) for a product . I wish to
> know whether any MSR( Magnetic Stripe/card Reader) driver is available
> in the current source or not. I need this for reference. Could anyone
> please help me?

Most of these types of devices that I have worked with always show up as
a keyboard device (ps/2 pass-through or a USB hid device.)  What type of
interface does your device present to the operating system?

thanks,

greg k-h

^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: Query related to MSR(Magnetic Stripe Reader) Device Driver
  2013-01-22 16:36 ` Greg KH
@ 2013-01-28  9:55   ` Priyaranjan Das
  2013-01-29 13:33     ` Greg KH
  0 siblings, 1 reply; 10+ messages in thread
From: Priyaranjan Das @ 2013-01-28  9:55 UTC (permalink / raw)
  To: Greg KH; +Cc: linux-kernel, mankad.maulik

Hi Greg,

On Tue, Jan 22, 2013 at 10:06 PM, Greg KH <gregkh@linuxfoundation.org> wrote:
> On Tue, Jan 22, 2013 at 03:02:32PM +0530, Priyaranjan Das wrote:
>> Hi All,
>>
>> I am working on MSR(Magnetic Stripe Reader) for a product . I wish to
>> know whether any MSR( Magnetic Stripe/card Reader) driver is available
>> in the current source or not. I need this for reference. Could anyone
>> please help me?
>
> Most of these types of devices that I have worked with always show up as
> a keyboard device (ps/2 pass-through or a USB hid device.)  What type of
> interface does your device present to the operating system?
>

The MSR will be a part of a SoC. It is  a memory mapped device hence
there is no interface like USB.
MSR IP contains an ADC which the driver will read and interpret the
data. I am planning to write a Driver for the same. Will this driver
fall under drivers/mfd/* ?

Regards,
Priyaranjan

^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: Query related to MSR(Magnetic Stripe Reader) Device Driver
  2013-01-28  9:55   ` Priyaranjan Das
@ 2013-01-29 13:33     ` Greg KH
  2013-01-31  5:39       ` Priyaranjan Das
  0 siblings, 1 reply; 10+ messages in thread
From: Greg KH @ 2013-01-29 13:33 UTC (permalink / raw)
  To: Priyaranjan Das; +Cc: linux-kernel, mankad.maulik

On Mon, Jan 28, 2013 at 03:25:08PM +0530, Priyaranjan Das wrote:
> Hi Greg,
> 
> On Tue, Jan 22, 2013 at 10:06 PM, Greg KH <gregkh@linuxfoundation.org> wrote:
> > On Tue, Jan 22, 2013 at 03:02:32PM +0530, Priyaranjan Das wrote:
> >> Hi All,
> >>
> >> I am working on MSR(Magnetic Stripe Reader) for a product . I wish to
> >> know whether any MSR( Magnetic Stripe/card Reader) driver is available
> >> in the current source or not. I need this for reference. Could anyone
> >> please help me?
> >
> > Most of these types of devices that I have worked with always show up as
> > a keyboard device (ps/2 pass-through or a USB hid device.)  What type of
> > interface does your device present to the operating system?
> >
> 
> The MSR will be a part of a SoC. It is  a memory mapped device hence
> there is no interface like USB.

Ok, that's different.  But how will your driver want to communicate the
reader data to userspace?  That will probably determine where you want
to put it.

I would recommend making it an input device and sending keystrokes that
you read from the card, so you can properly integrate into userspace
applications that are used to using a card reader.

> MSR IP contains an ADC which the driver will read and interpret the
> data. I am planning to write a Driver for the same. Will this driver
> fall under drivers/mfd/* ?

As per the above, I would think drivers/input/ wouldn't you?

Hope this helps,

greg k-h

^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: Query related to MSR(Magnetic Stripe Reader) Device Driver
  2013-01-29 13:33     ` Greg KH
@ 2013-01-31  5:39       ` Priyaranjan Das
  2013-02-15 11:18         ` Priyaranjan Das
  0 siblings, 1 reply; 10+ messages in thread
From: Priyaranjan Das @ 2013-01-31  5:39 UTC (permalink / raw)
  To: Greg KH; +Cc: linux-kernel, mankad.maulik

Hi Greg,

On Tue, Jan 29, 2013 at 7:03 PM, Greg KH <gregkh@linuxfoundation.org> wrote:
> On Mon, Jan 28, 2013 at 03:25:08PM +0530, Priyaranjan Das wrote:
>> Hi Greg,
>>
>> On Tue, Jan 22, 2013 at 10:06 PM, Greg KH <gregkh@linuxfoundation.org> wrote:
>> > On Tue, Jan 22, 2013 at 03:02:32PM +0530, Priyaranjan Das wrote:
>> >> Hi All,
>> >>
>> >> I am working on MSR(Magnetic Stripe Reader) for a product . I wish to
>> >> know whether any MSR( Magnetic Stripe/card Reader) driver is available
>> >> in the current source or not. I need this for reference. Could anyone
>> >> please help me?
>> >
>> > Most of these types of devices that I have worked with always show up as
>> > a keyboard device (ps/2 pass-through or a USB hid device.)  What type of
>> > interface does your device present to the operating system?
>> >
>>
>> The MSR will be a part of a SoC. It is  a memory mapped device hence
>> there is no interface like USB.
>
> Ok, that's different.  But how will your driver want to communicate the
> reader data to userspace?  That will probably determine where you want
> to put it.
>
> I would recommend making it an input device and sending keystrokes that
> you read from the card, so you can properly integrate into userspace
> applications that are used to using a card reader.
>
>> MSR IP contains an ADC which the driver will read and interpret the
>> data. I am planning to write a Driver for the same. Will this driver
>> fall under drivers/mfd/* ?
>
> As per the above, I would think drivers/input/ wouldn't you?
>
> Hope this helps,
>

Thanks for your help!.

Yes, you are right, it should be under drivers/input.
I am trying to prepare the design right now.


Regards,
Priyaranjan

^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: Query related to MSR(Magnetic Stripe Reader) Device Driver
  2013-01-31  5:39       ` Priyaranjan Das
@ 2013-02-15 11:18         ` Priyaranjan Das
  2013-02-15 16:36           ` Greg KH
  2013-02-15 17:28           ` Lars-Peter Clausen
  0 siblings, 2 replies; 10+ messages in thread
From: Priyaranjan Das @ 2013-02-15 11:18 UTC (permalink / raw)
  To: Greg KH, linux-iio; +Cc: linux-kernel, mankad.maulik

Hi Greg,

On Thu, Jan 31, 2013 at 11:09 AM, Priyaranjan Das
<priyaranjan456789@gmail.com> wrote:
> Hi Greg,
>
> On Tue, Jan 29, 2013 at 7:03 PM, Greg KH <gregkh@linuxfoundation.org> wrote:
>> On Mon, Jan 28, 2013 at 03:25:08PM +0530, Priyaranjan Das wrote:
>>> Hi Greg,
>>>
>>> On Tue, Jan 22, 2013 at 10:06 PM, Greg KH <gregkh@linuxfoundation.org> wrote:
>>> > On Tue, Jan 22, 2013 at 03:02:32PM +0530, Priyaranjan Das wrote:
>>> >> Hi All,
>>> >>
>>> >> I am working on MSR(Magnetic Stripe Reader) for a product . I wish to
>>> >> know whether any MSR( Magnetic Stripe/card Reader) driver is available
>>> >> in the current source or not. I need this for reference. Could anyone
>>> >> please help me?
>>> >
>>> > Most of these types of devices that I have worked with always show up as
>>> > a keyboard device (ps/2 pass-through or a USB hid device.)  What type of
>>> > interface does your device present to the operating system?
>>> >
>>>
>>> The MSR will be a part of a SoC. It is  a memory mapped device hence
>>> there is no interface like USB.
>>
>> Ok, that's different.  But how will your driver want to communicate the
>> reader data to userspace?  That will probably determine where you want
>> to put it.
>>
>> I would recommend making it an input device and sending keystrokes that
>> you read from the card, so you can properly integrate into userspace
>> applications that are used to using a card reader.
>>
>>> MSR IP contains an ADC which the driver will read and interpret the
>>> data. I am planning to write a Driver for the same. Will this driver
>>> fall under drivers/mfd/* ?
>>
>> As per the above, I would think drivers/input/ wouldn't you?
>>
>> Hope this helps,
>>
>
> Thanks for your help!.
>
> Yes, you are right, it should be under drivers/input.
> I am trying to prepare the design right now.
>
>

The MSR IP can be also be used either as a general purpose ADC or in
Magnetic stripe card reader mode.The IP supports both the modes and
provides FIFO for storing ADC data.

I also got to know about IIO subsystem where  ADC drivers are
implemented. Our use-case will be to use either Magnetic Stripe reader
mode or general purpose ADC mode in a given configuration. Can I use
IIO subsystem for the Magnetic Stripe driver?

Regards,
Priyaranjan

^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: Query related to MSR(Magnetic Stripe Reader) Device Driver
  2013-02-15 11:18         ` Priyaranjan Das
@ 2013-02-15 16:36           ` Greg KH
  2013-02-15 17:25             ` Jonathan Cameron
  2013-02-15 17:28           ` Lars-Peter Clausen
  1 sibling, 1 reply; 10+ messages in thread
From: Greg KH @ 2013-02-15 16:36 UTC (permalink / raw)
  To: Priyaranjan Das; +Cc: linux-iio, linux-kernel, mankad.maulik

On Fri, Feb 15, 2013 at 04:48:33PM +0530, Priyaranjan Das wrote:
> Hi Greg,
> 
> On Thu, Jan 31, 2013 at 11:09 AM, Priyaranjan Das
> <priyaranjan456789@gmail.com> wrote:
> > Hi Greg,
> >
> > On Tue, Jan 29, 2013 at 7:03 PM, Greg KH <gregkh@linuxfoundation.org> wrote:
> >> On Mon, Jan 28, 2013 at 03:25:08PM +0530, Priyaranjan Das wrote:
> >>> Hi Greg,
> >>>
> >>> On Tue, Jan 22, 2013 at 10:06 PM, Greg KH <gregkh@linuxfoundation.org> wrote:
> >>> > On Tue, Jan 22, 2013 at 03:02:32PM +0530, Priyaranjan Das wrote:
> >>> >> Hi All,
> >>> >>
> >>> >> I am working on MSR(Magnetic Stripe Reader) for a product . I wish to
> >>> >> know whether any MSR( Magnetic Stripe/card Reader) driver is available
> >>> >> in the current source or not. I need this for reference. Could anyone
> >>> >> please help me?
> >>> >
> >>> > Most of these types of devices that I have worked with always show up as
> >>> > a keyboard device (ps/2 pass-through or a USB hid device.)  What type of
> >>> > interface does your device present to the operating system?
> >>> >
> >>>
> >>> The MSR will be a part of a SoC. It is  a memory mapped device hence
> >>> there is no interface like USB.
> >>
> >> Ok, that's different.  But how will your driver want to communicate the
> >> reader data to userspace?  That will probably determine where you want
> >> to put it.
> >>
> >> I would recommend making it an input device and sending keystrokes that
> >> you read from the card, so you can properly integrate into userspace
> >> applications that are used to using a card reader.
> >>
> >>> MSR IP contains an ADC which the driver will read and interpret the
> >>> data. I am planning to write a Driver for the same. Will this driver
> >>> fall under drivers/mfd/* ?
> >>
> >> As per the above, I would think drivers/input/ wouldn't you?
> >>
> >> Hope this helps,
> >>
> >
> > Thanks for your help!.
> >
> > Yes, you are right, it should be under drivers/input.
> > I am trying to prepare the design right now.
> >
> >
> 
> The MSR IP can be also be used either as a general purpose ADC or in
> Magnetic stripe card reader mode.The IP supports both the modes and
> provides FIFO for storing ADC data.
> 
> I also got to know about IIO subsystem where  ADC drivers are
> implemented. Our use-case will be to use either Magnetic Stripe reader
> mode or general purpose ADC mode in a given configuration. Can I use
> IIO subsystem for the Magnetic Stripe driver?

The IIO developers would know best about this, not I, sorry.

greg k-h

^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: Query related to MSR(Magnetic Stripe Reader) Device Driver
  2013-02-15 16:36           ` Greg KH
@ 2013-02-15 17:25             ` Jonathan Cameron
  0 siblings, 0 replies; 10+ messages in thread
From: Jonathan Cameron @ 2013-02-15 17:25 UTC (permalink / raw)
  To: Greg KH, Priyaranjan Das; +Cc: linux-iio, linux-kernel, mankad.maulik



Greg KH <gregkh@linuxfoundation.org> wrote:

>On Fri, Feb 15, 2013 at 04:48:33PM +0530, Priyaranjan Das wrote:
>> Hi Greg,
>> 
>> On Thu, Jan 31, 2013 at 11:09 AM, Priyaranjan Das
>> <priyaranjan456789@gmail.com> wrote:
>> > Hi Greg,
>> >
>> > On Tue, Jan 29, 2013 at 7:03 PM, Greg KH
><gregkh@linuxfoundation.org> wrote:
>> >> On Mon, Jan 28, 2013 at 03:25:08PM +0530, Priyaranjan Das wrote:
>> >>> Hi Greg,
>> >>>
>> >>> On Tue, Jan 22, 2013 at 10:06 PM, Greg KH
><gregkh@linuxfoundation.org> wrote:
>> >>> > On Tue, Jan 22, 2013 at 03:02:32PM +0530, Priyaranjan Das
>wrote:
>> >>> >> Hi All,
>> >>> >>
>> >>> >> I am working on MSR(Magnetic Stripe Reader) for a product . I
>wish to
>> >>> >> know whether any MSR( Magnetic Stripe/card Reader) driver is
>available
>> >>> >> in the current source or not. I need this for reference. Could
>anyone
>> >>> >> please help me?
>> >>> >
>> >>> > Most of these types of devices that I have worked with always
>show up as
>> >>> > a keyboard device (ps/2 pass-through or a USB hid device.) 
>What type of
>> >>> > interface does your device present to the operating system?
>> >>> >
>> >>>
>> >>> The MSR will be a part of a SoC. It is  a memory mapped device
>hence
>> >>> there is no interface like USB.
>> >>
>> >> Ok, that's different.  But how will your driver want to
>communicate the
>> >> reader data to userspace?  That will probably determine where you
>want
>> >> to put it.
>> >>
>> >> I would recommend making it an input device and sending keystrokes
>that
>> >> you read from the card, so you can properly integrate into
>userspace
>> >> applications that are used to using a card reader.
>> >>
>> >>> MSR IP contains an ADC which the driver will read and interpret
>the
>> >>> data. I am planning to write a Driver for the same. Will this
>driver
>> >>> fall under drivers/mfd/* ?
>> >>
>> >> As per the above, I would think drivers/input/ wouldn't you?
>> >>
>> >> Hope this helps,
>> >>
>> >
>> > Thanks for your help!.
>> >
>> > Yes, you are right, it should be under drivers/input.
>> > I am trying to prepare the design right now.
>> >
>> >
>> 
>> The MSR IP can be also be used either as a general purpose ADC or in
>> Magnetic stripe card reader mode.The IP supports both the modes and
>> provides FIFO for storing ADC data.
>> 
>> I also got to know about IIO subsystem where  ADC drivers are
>> implemented. Our use-case will be to use either Magnetic Stripe
>reader
>> mode or general purpose ADC mode in a given configuration. Can I use
>> IIO subsystem for the Magnetic Stripe driver?
>
>The IIO developers would know best about this, not I, sorry.

The gp ADC stuff will fit nicely in IIO. I am afraid I don't know
 much about these devices. Could you give a brief description 
of what the hardware does and what processing and outputs 
you would want from the driver.


That separation between what is in hardware and what software may dictate how the driver is broken up.

Thanks

Jonathan
>
>greg k-h
>--
>To unsubscribe from this list: send the line "unsubscribe linux-iio" in
>the body of a message to majordomo@vger.kernel.org
>More majordomo info at  http://vger.kernel.org/majordomo-info.html

-- 
Sent from my Android phone with K-9 Mail. Please excuse my brevity.

^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: Query related to MSR(Magnetic Stripe Reader) Device Driver
  2013-02-15 11:18         ` Priyaranjan Das
  2013-02-15 16:36           ` Greg KH
@ 2013-02-15 17:28           ` Lars-Peter Clausen
  2013-02-19 12:43             ` Priyaranjan Das
  1 sibling, 1 reply; 10+ messages in thread
From: Lars-Peter Clausen @ 2013-02-15 17:28 UTC (permalink / raw)
  To: Priyaranjan Das; +Cc: Greg KH, linux-iio, linux-kernel, mankad.maulik

On 02/15/2013 12:18 PM, Priyaranjan Das wrote:
> Hi Greg,
> 
> On Thu, Jan 31, 2013 at 11:09 AM, Priyaranjan Das
> <priyaranjan456789@gmail.com> wrote:
>> Hi Greg,
>>
>> On Tue, Jan 29, 2013 at 7:03 PM, Greg KH <gregkh@linuxfoundation.org> wrote:
>>> On Mon, Jan 28, 2013 at 03:25:08PM +0530, Priyaranjan Das wrote:
>>>> Hi Greg,
>>>>
>>>> On Tue, Jan 22, 2013 at 10:06 PM, Greg KH <gregkh@linuxfoundation.org> wrote:
>>>>> On Tue, Jan 22, 2013 at 03:02:32PM +0530, Priyaranjan Das wrote:
>>>>>> Hi All,
>>>>>>
>>>>>> I am working on MSR(Magnetic Stripe Reader) for a product . I wish to
>>>>>> know whether any MSR( Magnetic Stripe/card Reader) driver is available
>>>>>> in the current source or not. I need this for reference. Could anyone
>>>>>> please help me?
>>>>>
>>>>> Most of these types of devices that I have worked with always show up as
>>>>> a keyboard device (ps/2 pass-through or a USB hid device.)  What type of
>>>>> interface does your device present to the operating system?
>>>>>
>>>>
>>>> The MSR will be a part of a SoC. It is  a memory mapped device hence
>>>> there is no interface like USB.
>>>
>>> Ok, that's different.  But how will your driver want to communicate the
>>> reader data to userspace?  That will probably determine where you want
>>> to put it.
>>>
>>> I would recommend making it an input device and sending keystrokes that
>>> you read from the card, so you can properly integrate into userspace
>>> applications that are used to using a card reader.
>>>
>>>> MSR IP contains an ADC which the driver will read and interpret the
>>>> data. I am planning to write a Driver for the same. Will this driver
>>>> fall under drivers/mfd/* ?
>>>
>>> As per the above, I would think drivers/input/ wouldn't you?
>>>
>>> Hope this helps,
>>>
>>
>> Thanks for your help!.
>>
>> Yes, you are right, it should be under drivers/input.
>> I am trying to prepare the design right now.
>>
>>
> 
> The MSR IP can be also be used either as a general purpose ADC or in
> Magnetic stripe card reader mode.The IP supports both the modes and
> provides FIFO for storing ADC data.
> 
> I also got to know about IIO subsystem where  ADC drivers are
> implemented. Our use-case will be to use either Magnetic Stripe reader
> mode or general purpose ADC mode in a given configuration. Can I use
> IIO subsystem for the Magnetic Stripe driver?

Hi,

Well for the ADC functionality it certainly makes sense to use the IIO
framework. The magnetic stripe reader functionality should probably go into
drivers/input. How to do this exactly depends a bit on how exactly the
hardware works. A good idea is probably to use a mfd driver which
instantiates both the input and the IIO driver and does some arbitration
between them. If the magnetic stripe reader is a feature that's build on top
of the ADC functionality you could use the IIO in-kernel API to do ADC
conversions from your input driver. If the ADC and magnetic stripe reader
mode are exclusive-or it probably makes sense to only instantiate one of
them at a time from the MFD driver.

- Lars


^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: Query related to MSR(Magnetic Stripe Reader) Device Driver
  2013-02-15 17:28           ` Lars-Peter Clausen
@ 2013-02-19 12:43             ` Priyaranjan Das
  0 siblings, 0 replies; 10+ messages in thread
From: Priyaranjan Das @ 2013-02-19 12:43 UTC (permalink / raw)
  To: Lars-Peter Clausen, Jonathan Cameron
  Cc: Greg KH, linux-iio, linux-kernel, mankad.maulik, linux-input, sameo

Hi Jonathan,Lars,

>>>
>>
>> The MSR IP can be also be used either as a general purpose ADC or in
>> Magnetic stripe card reader mode.The IP supports both the modes and
>> provides FIFO for storing ADC data.
>>
>> I also got to know about IIO subsystem where  ADC drivers are
>> implemented. Our use-case will be to use either Magnetic Stripe reader
>> mode or general purpose ADC mode in a given configuration. Can I use
>> IIO subsystem for the Magnetic Stripe driver?
>
> Hi,
>
> Well for the ADC functionality it certainly makes sense to use the IIO
> framework. The magnetic stripe reader functionality should probably go into
> drivers/input. How to do this exactly depends a bit on how exactly the
> hardware works. A good idea is probably to use a mfd driver which
> instantiates both the input and the IIO driver and does some arbitration
> between them. If the magnetic stripe reader is a feature that's build on top
> of the ADC functionality you could use the IIO in-kernel API to do ADC
> conversions from your input driver. If the ADC and magnetic stripe reader
> mode are exclusive-or it probably makes sense to only instantiate one of
> them at a time from the MFD driver.
>

The Hardware consists of an ADC and an in-built FIFO in it. The Device
can either be configured  as a Magnetic stripe reader or a GPADC.
After the ADC conversion,the data will be saved in the FIFO and the
driver has to read it and send it to the upper layers.Here the ADC and
Magnetic Stripe reader functionality are exclusively-or. In MSR mode,
the FIFO shall contain the track data for magnetic stripe card. This
data will be given to input subsystem.

To summarize below is my understanding:
1) drivers/input/misc: shall have the MSR driver.
2) drivers/iio/adc:   shall have the GPADC driver.
3) drivers/mfd:     shall support both above drivers and does arbitration.

Regards,
Priyaranjan

PS: Complete discussion can be found at [1]

[1] http://marc.info/?t=135884722400002&r=1&w=2

^ permalink raw reply	[flat|nested] 10+ messages in thread

end of thread, other threads:[~2013-02-19 12:43 UTC | newest]

Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2013-01-22  9:32 Query related to MSR(Magnetic Stripe Reader) Device Driver Priyaranjan Das
2013-01-22 16:36 ` Greg KH
2013-01-28  9:55   ` Priyaranjan Das
2013-01-29 13:33     ` Greg KH
2013-01-31  5:39       ` Priyaranjan Das
2013-02-15 11:18         ` Priyaranjan Das
2013-02-15 16:36           ` Greg KH
2013-02-15 17:25             ` Jonathan Cameron
2013-02-15 17:28           ` Lars-Peter Clausen
2013-02-19 12:43             ` Priyaranjan Das

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.