Jump to content

Help:Device Page/Template

From postmarketOS Wiki
This page is a template. It contains no postmarketOS-related information, but should be used as part of other articles.

Check out all pages using this template and feel free to discuss it in the gitlab issues.

For more information, read Templates and Template:Template.

This is a subpage of the Help:Device Page page, and only contains the raw template. For more information, see the linked page.

See also

{{Infobox device

<!-- Main -->
| manufacturer = CHANGE_ME <!-- e.g. Xiaomi -->
| name         = CHANGE_ME <!-- e.g. Redmi Note 13 Pro -->
| codename     = CHANGE_ME <!-- e.g. xiaomi-emerald -->
| model        = CHANGE_ME <!-- Manufacturer's model/part number, e.g. 2312DRA50G -->
| image        = File:CHANGE_ME_TO_DEVICE_CODENAME.jpg
| imagecaption = CHANGE_ME <!-- Brief description of the image -->
| releaseyear  = CHANGE_ME <!-- e.g. 2023 -->
| prereleaseyear = <!-- If the device was announced earlier than release -->

| booting = no <!-- *IMPORTANT* The device is booting at all, can be yes/no -->
| status  = <!-- Text displayed in the non-booting box, e.g "kernel compiles, doesn't boot" -->

| packaged = no <!-- yes if the device package has been merged into the pmaports repository -->
| category = <!-- main, community, testing, downstream -->


<!-- Hardware -->
| chipset = CHANGE_ME <!-- e.g. MediaTek Helio G99 (MT6789) -->
| cpu     = CHANGE_ME <!-- e.g. 2x 2.2 GHz Cortex-A76, 6x 2.0 GHz Cortex-A55 -->
| gpu     = CHANGE_ME <!-- e.g. Mali-G57 MC2 @ 850 MHz -->
| som     = <!-- Only applicable for carrier boards -->
| display = CHANGE_ME <!-- e.g. 1080 x 2400 AMOLED @ 120 Hz, 20:9, 6.67" -->
| storage = CHANGE_ME <!-- e.g. 128/256/512 GB -->
| memory  = CHANGE_ME <!-- e.g. 8/12 GB -->
| architecture = CHANGE_ME <!-- armhf, armv7, aarch64, riscv64, x86, x86_64 -->
| wp_type = 


<!-- Software -->
| originalsoftware = CHANGE_ME <!-- e.g. Android, Linux, Windows Phone -->
| originalversion  = CHANGE_ME <!-- e.g. 13 for Android 13 -->
| extendedversion  = <!-- Latest supported manufacturer OS version -->
| optionalsoftware = <!-- Other OS options -->
| status_fossbootloader = <!-- Y/P/N for FOSS bootloader -->


<!-- PostmarketOS -->
| type          = CHANGE_ME <!-- desktop, laptop, convertible, server, tablet, handset, watch, embedded, vm, see [[Device types]] -->
| pmoskernel    = 6.x.x <!-- Kernel version used in postmarketOS --> 
| whet_dhry     = 0.0 <!-- UnixBench score, see [[Unixbench]] -->
| genericdevice = <!-- Name of the generic port page -->
| optionalgenericdevice = no <!-- yes to change the genericdevice box into an optional genericdevice box -->
| devicepackage = <!-- {{Device package|device-codename|category}} -->
| kernelpackage = <!-- {{Kernel package|device-codename|category}} -->
| firmwarepackage = <!-- {{Firmware package|device-codename|category}} -->

<!-- Warning / Note boxes / Miscellaneous -->
| supported      = yes <!-- no if device cannot run postmarketOS (see [[Category:Unsupported Devices]]) -->
| prebuiltimages = no  <!-- yes if prebuilt images are aviable on the pmOS website -->
| boot_internal_storage = <!-- no if the device can't boot from internal storage -->
| bootable_media = <!-- Specify the media type that can be used to boot pmOS, e.g "USB Stick" -->
| changearch     = <!-- Optional, text displayed in the "changearch" box, e.g "armv7" -->

| initial_MR   = <!-- {{MR|CHANGE_ME|pmaports}} -->
| related_post = <!-- {{Lemmy|CHANGE_ME_TO_POST_ID}} -->



<!-- Features -->
<!-- 
For each of the following questions about device functionality, please respond as follows:
- Y for Yes     - if the feature works as expected
- P for Partial - if the feature works partially
- N for No      - if the feature does not work
- - for N/A     - if the feature is not applicable for the device
-   Leave blank - if the feature has not been tested
-->

<!-- Main Features -->
| status_flashing = <!-- Flashing with pmbootstrap -->
| status_usbnet   = <!-- USB networking -->
| status_emmc     = <!-- Internal storage -->
| status_sdcard   = <!-- SD card support -->
| status_battery  = <!-- Battery percentage/charging -->
| status_screen   = <!-- Built-in display/embedded display connector -->
| status_touch    = <!-- Touchscreen -->
| status_keyboard = <!-- Build in Physical Keyboard -->
| status_touchpad = <!-- Build in Physical Touchpad -->
| status_stylus   = <!-- Stylus/digital pen -->


<!-- Multimedia Features -->
| status_3d     = <!-- 3D acceleration -->
| status_dvb    = <!-- TV tuner -->
| status_audio  = <!-- Speakers/headphones -->
| status_camera = <!-- Rear/front cameras -->
| status_cameraflash = <!-- Flash/torch -->
| status_irtx   = <!-- IR transmitter -->
| status_irrx   = <!-- IR receiver -->


<!-- Connectivity Features -->
| status_wifi  = <!-- Wi-Fi -->
| status_bluetooth = <!-- Bluetooth -->
| status_ethernet = <!-- Wired Ethernet -->
| status_gps   = <!-- GPS -->
| status_nfc   = <!-- NFC -->
| status_calls = <!-- Cellular calls -->
| status_sms   = <!-- SMS -->
| status_mobiledata = <!-- Mobile data -->


<!-- Miscellaneous Features -->
| status_fde  = <!-- Full Disk Encryption -->
| status_usba = <!-- USB-A ports -->
| status_sata = <!-- SATA -->
| status_otg  = <!-- USB OTG -->
| status_hdmidp = <!-- HDMI/DisplayPort -->


<!-- Sensors -->
| status_accel     = <!-- Accelerometer -->
| status_magnet    = <!-- Magnetometer -->
| status_light     = <!-- Ambient light -->
| status_proximity = <!-- Proximity sensor -->
| status_hall      = <!-- Hall effect -->
| status_haptics   = <!-- Vibration/haptics -->
| status_barometer = <!-- Barometer -->
| status_powersensor = <!-- Power sensor -->


<!-- U-Boot (optional, for devices running U-Boot) -->
<!--
| status_uboot           =
| status_uboot_primary   =
| status_uboot_secondary =
| status_uboot_mainline  =
| status_uboot_internalstorage =
| status_uboot_sd        =
| status_uboot_usbhost   =
| status_uboot_usbperipheral =
| status_uboot_screen    =
| status_uboot_keyboard  =
| status_uboot_buttons   =
-->

}}

== Contributors ==
* [[User:CHANGE_ME]] <!-- Put your username here -->

<!--
== Maintainers ==
* [[User:CHANGE_ME]]

-->
== Users owning this device ==
{{Device owners}}
<!--
Autogenerated, use {{Owns device|devicepage|notes}} on your profile page. (See [[Template:Owns device]])
You may need to purge page cache to see changes (Purge cache on the Tools sidebar).
You can use {{My devices}} on your profile page to show a table with all your devices.
-->

== How to enter flash mode ==
{{note|Add step-by-step instructions for enabling flash mode.}}

== Installation ==
=== Using pmbootstrap ===
Follow [[Installation/Using pmbootstrap]]. When asked for the device's vendor/codename, select FIXME as the vendor and FIXME as the codename. <!-- replace FIXMEs with the vendor and codename part of the codename -->

To flash the image to the device:

* Enter flashing mode (see [[#How to enter flash mode]])
* Run <code>pmbootstrap flasher flash_kernel</code> to flash the kernel
* Run <code>pmbootstrap flasher flash_rootfs</code>
<!-- 
Add more instructions if necessary

=== Add more methods if necessary ===

== Add more sections below as necessary, e.g. WiFi, photos, ... ==
-->

== See also ==
* [[{{FULLPAGENAME}}/Scratchpad|Scratchpad]]
<!--
Link to related GitLab issues or merge requests like the following (replace CHANGE_ME with the ID, e.g. 1234):
* {{MR|CHANGE_ME|pmaports}} Initial merge request
* {{issue|CHANGE_ME|pmaports}} Some related issue

You can also add normal web links and link templates:
* {{replicant|GalaxySIIGTI9100|Galaxy S II (GT-I9100)}}
* {{sunxi|A64|Allwinner A64}}
* [https://xdaforums.com/t/example Example link]
-->