<p>Harald Welte <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/12859">View Change</a></p><div style="white-space:pre-wrap">Approvals:
  Jenkins Builder: Verified
  Harald Welte: Looks good to me, approved

</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">add README file<br><br>Change-Id: I9286493e4e2d20f00a33e7b565adde10198f179a<br>---<br>A sysmoOCTSIM/README.md<br>1 file changed, 46 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/sysmoOCTSIM/README.md b/sysmoOCTSIM/README.md</span><br><span>new file mode 100644</span><br><span>index 0000000..1927255</span><br><span>--- /dev/null</span><br><span>+++ b/sysmoOCTSIM/README.md</span><br><span>@@ -0,0 +1,46 @@</span><br><span style="color: hsl(120, 100%, 40%);">+The sysmocom sysmoOCTSIM is a USB CCID device with eight smart card slots.</span><br><span style="color: hsl(120, 100%, 40%);">+This is the open source firmware for this device.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Hardware</span><br><span style="color: hsl(120, 100%, 40%);">+========</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The sysmocom sysmoOCTSIM hardware is proprietary.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+It has the following specifications:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+- 8 smart cards slots for 2FF cards (e.g. normal SIM format)</span><br><span style="color: hsl(120, 100%, 40%);">+- each slot is driven individually (e.g. they are not multiplexed)</span><br><span style="color: hsl(120, 100%, 40%);">+- each card can be operated in class A (5.0 V), B (3.0 V), or C (1.8 V)</span><br><span style="color: hsl(120, 100%, 40%);">+- the ISO/IEC 7816-4 T=0 communication protocol is used</span><br><span style="color: hsl(120, 100%, 40%);">+- each card can be clock up to 20 MHz (e.g. maximum allowed by the standard)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+For more detailed specification refer to the USB description of the device.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Firmware</span><br><span style="color: hsl(120, 100%, 40%);">+========</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Compiling</span><br><span style="color: hsl(120, 100%, 40%);">+---------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+GNU make and the arm-none-eabi-gcc compiler are required to build the firmware.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The compile the firmware, run the following commands:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span style="color: hsl(120, 100%, 40%);">+cd sysmoOCTSIM/gcc</span><br><span style="color: hsl(120, 100%, 40%);">+make</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The `sysmoOCTSIM/gcc/AtmelStart.bin` file is the resulting firmware for the device.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Flashing</span><br><span style="color: hsl(120, 100%, 40%);">+--------</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The device comes pre-flash with a USB DFU bootloader (e.g. [osmo-asf4-dfu](https://git.osmocom.org/osmo-asf4-dfu/)).</span><br><span style="color: hsl(120, 100%, 40%);">+To start the USB DFU bootloader, press on the button on the front right of the panel while powering up the device.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Use the [dfu-util](http://dfu-util.sourceforge.net/) utility to flash the firmware onto the device:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span style="color: hsl(120, 100%, 40%);">+dfu-util --device 1d50:6141 --download sysmoOCTSIM/gcc/AtmelStart.bin</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/12859">change 12859</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/12859"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: osmo-ccid-firmware </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: I9286493e4e2d20f00a33e7b565adde10198f179a </div>
<div style="display:none"> Gerrit-Change-Number: 12859 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Kévin Redon <kredon@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder (1000002) </div>