Commit 916906f2 authored by Kyle Rankin's avatar Kyle Rankin
Browse files

Merge branch 'publish-birch-hardware-docs' into 'master'

Publish Birch hardware docs

See merge request Librem5/developer.puri.sm!345
parents a8e6a1e6 408b8501
......@@ -5,188 +5,11 @@ Hardware Reference
.. https://source.puri.sm/Librem5/dvk-mx8m-bsb/tree/master/BoM
This chapter contains a description of the hardware included with the **Librem 5
developer kit**. The sections contain information about the developer kits from
`this blog post <https://puri.sm/posts/librem5-2018-11-hardware-report/>`_ and
are being updated to provide more details and links to resources.
This chapter contains a description of the hardware included with the Librem 5 developer kit and each revision of the phone.
Librem 5 Devkit
---------------
* `Customer grade i.MX 8M Quad <https://www.nxp.com/products/processors-and-microcontrollers/arm-based-processors-and-mcus/i.mx-applications-processors/i.mx-8-processors/i.mx-8m-family-armcortex-a53-cortex-m4-audio-voice-video:i.MX8M>`_ [`datasheet <https://www.nxp.com/docs/en/data-sheet/IMX8MDQLQIEC.pdf>`_]
and [`reference manual <https://www.nxp.com/webapp/Download?colCode=IMX8MDQLQRM>`_]
* Four ARM Cortex A54 cores.
* One Cortex M4.
* Vivante GC7000Lite graphics
* 1 x Gigabit Ethernet
* 32 GB eMMC
* 3GB RAM
* SPI NOR Flash
* Real Time Clock (RTC)
.. _`hardware_ref_micro_sd`:
Micro SD Card
~~~~~~~~~~~~~
* ALPS SCHA4B0419 MicroSD card slot [`datasheet <SCHA4B0419_>`_]
.. _`hardware_ref_micro_sim`:
Micro SIM Card
~~~~~~~~~~~~~~
* `JAE SF56 <http://www.jae.com/jccom/en/connectors/detail/SF56>`_ micro SIM card slot [`datasheet <SF56S006V4BR2000_>`_]
.. _`hardware_ref_smart_card`:
Smart Card
~~~~~~~~~~
* `Microchip SEC1110 <https://www.microchip.com/wwwproducts/en/SEC1110>`_ smart card reader [`datasheet <SEC1110_>`_]
* Amphenol 1010027182 smart card slot [`datasheet <1010027182_>`_]
Battery
~~~~~~~
* `Texas Instruments BQ25896 <http://www.ti.com/product/BQ25896>`_ battery charge controller [`datasheet <BQ25896_>`_]
* `COMF BHC-18650-1P <http://www.comf.com.tw/ProductDetail.asp?no=99>`_ 18650 battery holder [`datasheet <BHC-18650-1P_>`_]
.. _`hardware_ref_display`:
Display
~~~~~~~
* HDMI output via Mini-HDMI
* Rocktech JH057N00900 MIPI DSI LCD panel: 720x1440 pixels and touch
controller
Camera
~~~~~~
* Omnivision OV5640 MIPI CSI Camera [`datasheet <OV5640_>`_]
.. _`hardware_ref_push_buttons`:
Push Buttons
~~~~~~~~~~~~
* Power
* Reset
* Volume up
* Volume down
.. _`hardware_ref_kill_switches`:
Hardware Kill Switches
~~~~~~~~~~~~~~~~~~~~~~
* WWAN (Modem)
* Wifi/Bluetooth
* Microphone and Camera
.. _`hardware_ref_audio`:
Audio
~~~~~
* `NXP SGTL5000 <https://www.nxp.com/products/media-and-audio/audio-converters/audio-codec/ultra-low-power-audio-codec:SGTL5000>`_ audio codec [`datasheet <SGTL5000_>`_]
* `CUI CMC-2242PBL-A <https://www.cui.com/product/audio/microphones/electret-condenser-microphones/cmc-2242pbl-a>`_ electret condenser microphone [`datasheet <CMC-2242PBL-A_>`_]
* `PUI Audio AS01508MS-SP11-WP-R <http://www.puiaudio.com/product-detail.aspx?categoryId=6&partnumber=AS01508MS-SP11-WP-R>`_ speaker [`datasheet <AS01508MS-SP11-WP-R_>`_]
* Headphones and external microphone via CTIA-configured 3.5mm jack
Bluetooth, Wi-Fi, WWAN
~~~~~~~~~~~~~~~~~~~~~~
* Bluetooth I2S interface
* Bluetooth (SDIO)
* RedPine WiFi/BT M.2 module on SDIO
* SIMCom SIM7100E or SIM7100A WWAN module
GNSS
~~~~
* ublox MAX-M8Q GNSS (UART3 interface and antenna)
Sensors and Motors
~~~~~~~~~~~~~~~~~~
* Haptic motor
* ST LSM9D1 accelerometer, gyro, magnetometer
* Proximity / ambient light sensor [`datasheet <VCNL4040M3OE-H5_>`_]
.. _`hardware_ref_usb`:
USB
~~~
* Serial Downloader support (loading u-boot via USB)
* USB-C port including USB-C role switching
* USB Hub and SD controller
.. _hardware_ref_headers:
Headers
~~~~~~~
* JTAG header (unpopulated)
* UART Debug (unpopulated, 2.54 mm / 0.1 inch pitch):
+-----+-------+----------+
| PIN | Color | Function |
+=====+=======+==========+
| 1 | black | GND |
+-----+-------+----------+
| 2 | | NC |
+-----+-------+----------+
| 3 | | NC |
+-----+-------+----------+
| 4 | green | TX |
+-----+-------+----------+
| 5 | white | RX |
+-----+-------+----------+
| 6 | | NC |
+-----+-------+----------+
Note: PIN 1 is the one closest to the volume button while PIN6 is the one closest to the power button. The pin functions are documented from the perspective of a USB to serial adapter -- the devkit receives serial input on pin 4 and transmits serial output on pin 5.
LEDs
~~~~
* Power indicator
The three power LED indicators are located next to the battery holder on the board.
+------------+--------------------------+------------------------------------------------------+
| Silkscreen | Location | Function |
+============+==========================+======================================================+
| D304 |br| | Closest to the edge |br| | Charge controller output voltage (VBAT_REG) |br| |
| |br| | of the board with |br| | is properly outputting its supply voltage. |br| |
| |br| | the power button | |br| |
+------------+--------------------------+------------------------------------------------------+
| D301 |br| | Between LED D304 |br| | Indicates that there is a good supply voltage |br| |
| |br| | and D302 | from USB VBUS. |
+------------+--------------------------+------------------------------------------------------+
| D302 |br| | Closest to the edge |br| | If solid-on, the battery is being charged. |br| |
| |br| | of the board with |br| | If solid-off, then no battery is being charged. |br| |
| |br| | the reset button |br| | If blinking at ~9Hz or more, then no battery is |br| |
| |br| | |br| | inserted. |br| |
| |br| | |br| | If blinking at 1Hz then there is some fault |br| |
| |br| | |br| | condition. |
+------------+--------------------------+------------------------------------------------------+
* User controllable LED
For more details have a look at the `schematics <https://source.puri.sm/Librem5/dvk-mx8m-bsb/blob/master/dvk-mx8m-bsb.pdf>`_.
Librem 5 Phone
--------------
.. note:: This section is subject to updates and revisions prior to the phone's
release.
.. toctree::
Hardware_Reference/devkit
Hardware_Reference/Birch
.. include:: /links.txt
.. _hardware_reference_birch:
Librem 5 Phone -- Birch
=======================
The sections on this page contain information about the Birch revision of the Librem 5 phone.
.. contents::
Schematics
----------
The following schematics are available:
* Librem 5 Birch main board: :download:`librem5_birch_mainboard_schematic.pdf <_files/librem5_birch_mainboard_schematic.pdf>`
* Librem 5 Birch USB C board: :download:`librem5_birch_usb-c_board_schematic.pdf <_files/librem5_birch_usb-c_board_schematic.pdf>`
X-Rays
------
The images below show X-ray images of the circuit boards. Click on the images to see larger versions.
First view:
.. |image-1| image:: images/Birch/1.jpg
:scale: 15%
:alt: Top-left of upper side of the circuit board
.. |image-2| image:: images/Birch/2.jpg
:scale: 15%
:alt: Top-right of upper side of the circuit board
.. |image-3| image:: images/Birch/3.jpg
:scale: 15%
:alt: Middle-left of upper side of the circuit board
.. |image-4| image:: images/Birch/4.jpg
:scale: 15%
:alt: Middle-right of upper side of the circuit board
.. |image-5| image:: images/Birch/5.jpg
:scale: 15%
:alt: Lower-left of upper side of the circuit board
.. |image-6| image:: images/Birch/6.jpg
:scale: 15%
:alt: Lower-right of upper side of the circuit board
.. |image-7| image:: images/Birch/7.jpg
:scale: 15%
:alt: Left end of upper side of the USB connector board
.. |image-8| image:: images/Birch/8.jpg
:scale: 15%
:alt: Right end of upper side of the USB connector board
.. centered:: |image-1| |image-2|
.. centered:: |image-3| |image-4|
.. centered:: |image-5| |image-6|
.. centered:: |image-7| |image-8|
Second view:
.. |image-d5| image:: images/Birch/d5.jpg
:scale: 15%
:alt: Top-left of lower side of the circuit board
.. |image-d6| image:: images/Birch/d6.jpg
:scale: 15%
:alt: Top-right of lower side of the circuit board
.. |image-d4| image:: images/Birch/d4.jpg
:scale: 15%
:alt: Middle-left of lower side of the circuit board
.. |image-d3| image:: images/Birch/d3.jpg
:scale: 15%
:alt: Middle-right of lower side of the circuit board
.. |image-d1| image:: images/Birch/d1.jpg
:scale: 15%
:alt: Lower-left of lower side of the circuit board
.. |image-d2| image:: images/Birch/d2.jpg
:scale: 15%
:alt: Lower-right of lower side of the circuit board
.. |image-c2| image:: images/Birch/c2.jpg
:scale: 15%
:alt: Left end of lower side of the USB connector board
.. |image-c1| image:: images/Birch/c1.jpg
:scale: 15%
:alt: Right end of lower side of the USB connector board
.. centered:: |image-d5| |image-d6|
.. centered:: |image-d4| |image-d3|
.. centered:: |image-d1| |image-d2|
.. centered:: |image-c2| |image-c1|
Third view:
.. |image-b2| image:: images/Birch/b2.jpg
:scale: 15%
:alt: Top-left of the circuit board
.. |image-b1| image:: images/Birch/b1.jpg
:scale: 15%
:alt: Top-right of the circuit board
.. |image-b3| image:: images/Birch/b3.jpg
:scale: 15%
:alt: Upper-middle-left of the circuit board
.. |image-b4| image:: images/Birch/b4.jpg
:scale: 15%
:alt: Upper-middle-right of the circuit board
.. |image-b6| image:: images/Birch/b6.jpg
:scale: 15%
:alt: Middle-left of the circuit board
.. |image-b5| image:: images/Birch/b5.jpg
:scale: 15%
:alt: Middle-right of the circuit board
.. |image-b7| image:: images/Birch/b7.jpg
:scale: 15%
:alt: Lower-middle-left of the circuit board
.. |image-b8| image:: images/Birch/b8.jpg
:scale: 15%
:alt: Lower-middle-right of the circuit board
.. |image-b10| image:: images/Birch/b10.jpg
:scale: 15%
:alt: Lower-left of the circuit board
.. |image-b9| image:: images/Birch/b9.jpg
:scale: 15%
:alt: Lower-right of the circuit board
.. centered:: |image-b2| |image-b1|
.. centered:: |image-b3| |image-b4|
.. centered:: |image-b6| |image-b5|
.. centered:: |image-b7| |image-b8|
.. centered:: |image-b10| |image-b9|
Complete stitched images:
.. |complete-stitched-images| image:: images/Birch/stitched.jpg
:scale: 15%
:alt: Complete X-rays images of the Librem 5 circuit board
.. centered:: |complete-stitched-images|
.. _hardware_reference_devkit:
Librem 5 Devkit
===============
The sections on this page contain information about the developer kits from `this blog post <https://puri.sm/posts/librem5-2018-11-hardware-report/>`_ and have been updated to provide more details and links to resources.
System on Chip and Peripherals
------------------------------
* `Customer grade i.MX 8M Quad <https://www.nxp.com/products/processors-and-microcontrollers/arm-based-processors-and-mcus/i.mx-applications-processors/i.mx-8-processors/i.mx-8m-family-armcortex-a53-cortex-m4-audio-voice-video:i.MX8M>`_ [`datasheet <https://www.nxp.com/docs/en/data-sheet/IMX8MDQLQIEC.pdf>`_]
and [`reference manual <https://www.nxp.com/webapp/Download?colCode=IMX8MDQLQRM>`_]
* Four ARM Cortex A54 cores.
* One Cortex M4.
* Vivante GC7000Lite graphics
* 1 x Gigabit Ethernet
* 32 GB eMMC
* 3GB RAM
* SPI NOR Flash
* Real Time Clock (RTC)
.. _`hardware_ref_micro_sd`:
Micro SD Card
-------------
* ALPS SCHA4B0419 MicroSD card slot [`datasheet <SCHA4B0419_>`_]
.. _`hardware_ref_micro_sim`:
Micro SIM Card
--------------
* `JAE SF56 <http://www.jae.com/jccom/en/connectors/detail/SF56>`_ micro SIM card slot [`datasheet <SF56S006V4BR2000_>`_]
.. _`hardware_ref_smart_card`:
Smart Card
----------
* `Microchip SEC1110 <https://www.microchip.com/wwwproducts/en/SEC1110>`_ smart card reader [`datasheet <SEC1110_>`_]
* Amphenol 1010027182 smart card slot [`datasheet <1010027182_>`_]
Battery
-------
* `Texas Instruments BQ25896 <http://www.ti.com/product/BQ25896>`_ battery charge controller [`datasheet <BQ25896_>`_]
* `COMF BHC-18650-1P <http://www.comf.com.tw/ProductDetail.asp?no=99>`_ 18650 battery holder [`datasheet <BHC-18650-1P_>`_]
.. _`hardware_ref_display`:
Display
-------
* HDMI output via Mini-HDMI
* Rocktech JH057N00900 MIPI DSI LCD panel: 720x1440 pixels and touch
controller
Camera
------
* Omnivision OV5640 MIPI CSI Camera [`datasheet <OV5640_>`_]
.. _`hardware_ref_push_buttons`:
Push Buttons
------------
* Power
* Reset
* Volume up
* Volume down
.. _`hardware_ref_kill_switches`:
Hardware Kill Switches
----------------------
* WWAN (Modem)
* Wifi/Bluetooth
* Microphone and Camera
.. _`hardware_ref_audio`:
Audio
-----
* `NXP SGTL5000 <https://www.nxp.com/products/media-and-audio/audio-converters/audio-codec/ultra-low-power-audio-codec:SGTL5000>`_ audio codec [`datasheet <SGTL5000_>`_]
* `CUI CMC-2242PBL-A <https://www.cui.com/product/audio/microphones/electret-condenser-microphones/cmc-2242pbl-a>`_ electret condenser microphone [`datasheet <CMC-2242PBL-A_>`_]
* `PUI Audio AS01508MS-SP11-WP-R <http://www.puiaudio.com/product-detail.aspx?categoryId=6&partnumber=AS01508MS-SP11-WP-R>`_ speaker [`datasheet <AS01508MS-SP11-WP-R_>`_]
* Headphones and external microphone via CTIA-configured 3.5mm jack
Bluetooth, Wi-Fi, WWAN
----------------------
* Bluetooth I2S interface
* Bluetooth (SDIO)
* RedPine WiFi/BT M.2 module on SDIO
* SIMCom SIM7100E or SIM7100A WWAN module
GNSS
----
* ublox MAX-M8Q GNSS (UART3 interface and antenna)
Sensors and Motors
------------------
* Haptic motor
* ST LSM9D1 accelerometer, gyro, magnetometer
* Proximity / ambient light sensor [`datasheet <VCNL4040M3OE-H5_>`_]
.. _`hardware_ref_usb`:
USB
---
* Serial Downloader support (loading u-boot via USB)
* USB-C port including USB-C role switching
* USB Hub and SD controller
.. _hardware_ref_headers:
Headers
-------
* JTAG header (unpopulated)
* UART Debug (unpopulated, 2.54 mm / 0.1 inch pitch):
+-----+-------+----------+
| PIN | Color | Function |
+=====+=======+==========+
| 1 | black | GND |
+-----+-------+----------+
| 2 | | NC |
+-----+-------+----------+
| 3 | | NC |
+-----+-------+----------+
| 4 | green | TX |
+-----+-------+----------+
| 5 | white | RX |
+-----+-------+----------+
| 6 | | NC |
+-----+-------+----------+
Note: PIN 1 is the one closest to the volume button while PIN6 is the one closest to the power button. The pin functions are documented from the perspective of a USB to serial adapter -- the devkit receives serial input on pin 4 and transmits serial output on pin 5.
LEDs
----
* Power indicator
The three power LED indicators are located next to the battery holder on the board.
+------------+--------------------------+------------------------------------------------------+
| Silkscreen | Location | Function |
+============+==========================+======================================================+
| D304 |br| | Closest to the edge |br| | Charge controller output voltage (VBAT_REG) |br| |
| |br| | of the board with |br| | is properly outputting its supply voltage. |br| |
| |br| | the power button | |br| |
+------------+--------------------------+------------------------------------------------------+
| D301 |br| | Between LED D304 |br| | Indicates that there is a good supply voltage |br| |
| |br| | and D302 | from USB VBUS. |
+------------+--------------------------+------------------------------------------------------+
| D302 |br| | Closest to the edge |br| | If solid-on, the battery is being charged. |br| |
| |br| | of the board with |br| | If solid-off, then no battery is being charged. |br| |
| |br| | the reset button |br| | If blinking at ~9Hz or more, then no battery is |br| |
| |br| | |br| | inserted. |br| |
| |br| | |br| | If blinking at 1Hz then there is some fault |br| |
| |br| | |br| | condition. |
+------------+--------------------------+------------------------------------------------------+
* User controllable LED
For more details have a look at the `schematics <https://source.puri.sm/Librem5/dvk-mx8m-bsb/blob/master/dvk-mx8m-bsb.pdf>`_.
.. include:: /links.txt
Markdown is supported
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