Commit f358d3af authored by Tim M's avatar Tim M Committed by Heather Ellsworth
Browse files

copyedit the Development Board section

parent 7d3979d2
......@@ -3,13 +3,33 @@
Development Boards
==================
Developing a dev kit and eventually a phone is a process that requires iterations over hardware to test and determine which pieces are good to use in the ultimate Librem 5 phone and which aren't. What defines a hardware componenet to be good for the phone? There are several components like performance, freedom of the firmware (if any), physical size, voltage required, features of the hardware component, etc.
On the freedom front, we have been committed to the i.MX line of CPUs (instead of say Intel). Since the i.MX8 CPU had not been released when the Librem 5 team started testing (January 2018), we have started our investigation with the `Nitrogen6 MAX i.MX6 board <https://boundarydevices.com/product/nitrogen6max/>`_.
Once the i.MX8 CPU was released, and the `EmCraft i.MX 8M SoM <https://www.emcraft.com/products/868>`_ was available, a few were ordered so the rest of the dev board could be designed around this EmCraft SoM. Until the dev kit is available, the :ref:`Dev-kit` page will remain empty. However once the dev kit *is* available, this is where you will find complete information on the hardware and how to set up your dev kit to start using it.
Also take a look at the :ref:`mini-tutorials` page for some common commands and some application setup that is not board specific.
Developing a dev kit and eventually a phone is a long process that
requires many hardware iterations over time to test and determine
which pieces are good to use in the final product and which aren't.
What defines a good hardware component for the Librem 5 phone? There
are several metrics such as performance, freedom of the firmware
(if any), physical size, voltage required, features supported and
more that are taken into account when selecting hardware components
for the Librem 5 phone.
On the freedom front, we have been committed to the i.MX line of
CPUs as opposed to something less freedom respecting such as Intel
hardware. Since the i.MX8 CPU had not been released when the Librem
5 team started testing (January 2018), we started our investigation
with the `Nitrogen6 MAX i.MX6 board <https://boundarydevices.com/product/nitrogen6max/>`_.
Once the i.MX8 CPU was released, and the
`EmCraft i.MX 8M SoM <https://www.emcraft.com/products/868>`_
was available, a few were ordered so the rest of the dev board
could be designed around this EmCraft SoM. Until the dev kit is
available, the :ref:`Dev-kit` page will remain empty. However
once the dev kit *is* available, this is where you will find
complete information on the hardware and how to set up your dev
kit to start using it.
Also take a look at the :ref:`mini-tutorials` page for some common
commands and some application setup that is not board specific.
.. toctree::
:maxdepth: 1
......@@ -18,4 +38,4 @@ Also take a look at the :ref:`mini-tutorials` page for some common commands and
Boards/real-hardware
Boards/emulators
Boards/mini-tutorials
......@@ -4,4 +4,5 @@
Dev Kit
=======
TBD
This page will be populated with information on the i.MX8 based dev kits
once they are finalized and shipped. Check back for updates!
......@@ -3,7 +3,7 @@
First Steps
===========
The development board (whether a physical one or emulated one) will give you a place to see the effects of the active Librem 5 development. The software running on this board will become the software running on the Librem 5 phone but you don't have to wait for your Librem 5 phone to interact with it!
The development board (whether a physical one or an emulated one) will give you a place to see the effects of the active Librem 5 development. The software running on this board will become the software running on the Librem 5 phone but you don't have to wait for your Librem 5 phone to interact with it!
Regardless of which development board you are using, here are some first steps you will take when booting the system.
......@@ -20,7 +20,7 @@ To complete this section, you will need:
* a microSD card
* a method of accessig the microSD card with your computer (like a microSD <-> USB card reader)
Using your microSD <-> USB reader, mount the microSD card and take note of the device (with ``lsblk`` or ``df``). Then unmount it. For this walkthrough, the device is /dev/sdd::
Using your microSD <-> USB reader or internal microSD card reader, mount the microSD card and take note of the device (with ``lsblk`` or ``df``). Then unmount it. The device name will be listed in the first collumn of the output of ``lsblk`` as shown below. On most GNU/Linux systems the device name will be /dev/mmcblk0 (for internal card readers), /dev/sdX (for external card readers) or something similar. If it is listed as /dev/sdX, the X will actually be some letter corresponding to the device (in this example, /dev/sdd). For this walkthrough, the device is /dev/sdd. Make careful note of the device name on your system as you can and will lose data if you get the device name wrong::
$ lsblk
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
......@@ -84,7 +84,7 @@ Applications
In the top left corner you can click anywhere on "Librem5 dev board" to open up a favorites menu with the following default applications: weston-terminal, contacts, calendar, evince, and epiphany (for web browsing).
From the terminal, you can do all the normal things like configure networking, install additional applications, etc.
From the terminal, you can do all the normal things like configuring networking, installing additional applications, etc.
**Have fun tinkering in your new development environment!**
......@@ -4,12 +4,12 @@
Mini-Tutorials
==============
This page is a collection of some helpful commands to setup various applications and test their functionality within the dev boards. These tidbits are not specific to any one board but rather are generally usefull guides.
This page is a collection of some helpful commands to setup various applications and test their functionality within the dev boards. These tidbits are not specific to any one board but are rather generally useful guides.
MC7455 Baseband Modem mPCIe Card
################################
If you are testing the Sierra Wireless MC7455 with the Nit6QP_MAX then make sure you cover pin 22 with some adhesive film to prevent the modem from resetting over and over. It is okay to cover pin 20 as it is floating anyway. Pin 18 is GND and covering it is not prefered but _may_ be safe to do so.
If you are testing the Sierra Wireless MC7455 with the Nit6QP_MAX, make sure you cover pin 22 with some adhesive film to prevent the modem from resetting over and over. It is okay to cover pin 20 as it is floating anyway. Pin 18 is GND and covering it is not prefered but _may_ be safe to do so.
Pin 22 is the one that is blacked out in this image:
`cover this pin <https://talk.puri.sm/_matrix/media/v1/download/talk.puri.sm/jzwIpANihuiyChonjlLvdLaM>`_
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment