Gentoo Wiki:Article Blueprints/Hardware/Embedded

From Gentoo Wiki
Jump to: navigation, search

The following is a semi-structured, rough embedded board article blueprint users can copy and paste to create new embedded hardware articles. In general, it follows the Wiki guidelines (review if necessary). Be aware some information provided in the blueprint may not be needed; wiki contributors know it is easier to delete unneeded content than to type out new content. These sections are typically identified with "Optional section" in the sections leading sentence.

  • Before copying it is possible to demo the Embedded article blueprint by going here.
Important
Not every hardware platform article will fit into the outline of this blueprint; it is simply a rough framework to assist in article creation. Modify as needed!

Suggestion for the article's Summary field: Initial creation of the <Make_Model> article. Show it some love by improving it!

{{InfoBox stack
|{{InfoBox homepage|http://url/to/hardware/manufacturer's/product/homepage|header=true}}
|{{InfoBox wikipedia|HardwareArticleOnWikipedia}}
}}

(Introductory paragraph goes here. Describe the hardware. It is okay to mention the hardware platforms friendliness to open source drivers. Optionally, it is nice provide a nice summary of why or why not a user would want to buy this hardware for use with Linux.)

== Hardware ==

=== Standard ===

{| class="table table-condensed table-striped" style="width: auto;"
! scope="col" width="20%" | Device
! scope="col" width="20%" | Make/model
! scope="col" width="10%" | Status
! scope="col" width="10%" | Bus ID
! scope="col" width="10%" | Kernel driver(s)
! scope="col" width="10%" | Kernel version
! scope="col" width="20%" | Notes
|-
| CPU
| AMD Phenom(tm) II X4 955
| {{Yes|Works}}
| N/A
| N/A
| 3.18.9
| This CPU rocks!
|-
| Front side bus
| RD790 Host Bridge
| {{Partial|Not tested}}
| 1002:5956
| pcieport
| 3.18.9
| Note example.
|-
| Video card
| NVIDIA Corporation NV18 [GeForce4 MX 4000]
| {{No|Borked}}
| 10de:0185
| nouveau
| 3.18.9
| Note example.
|}

=== Accessories ===

(Optional section. Describe any accessories that may be possible in this section. Anything from external plug-and-play LCD screens to computer docks.)

{| class="table table-condensed table-striped" style="width: auto;"
! scope="col" width="20%" | Device
! scope="col" width="20%" | Make/model
! scope="col" width="10%" | Status
! scope="col" width="10%" | Bus ID
! scope="col" width="10%" | Kernel driver(s)
! scope="col" width="10%" | Kernel version
! scope="col" width="20%" | Notes
|-
| LCD touch screen
| Tontec TT-350-PI-TS
| {{Partial|Not tested}}
| N/A
| N/A
| >=3.18.9
| Note example.
|}

== Installation ==

(Write the necessary steps to get Gentoo onto this system. Try to document any special step that each user will need to reproduce on their system. Includes getting special drivers or firmware from a manufacturer website, etc.)

=== Firmware ===

(Optional section.)

=== Kernel ===

(Show what options are necessary in the kernel in order to get all device components functional for this hardware platform.)

{{KernelBox|title=Enable support for these hardware drivers|1=

Write menuconfig instructions here.

}}

=== Emerge ===

(Optional section. If the platform requires any user space packages or kernel patches, mention them here).

{{Emerge|category/package}}

== Configuration ==

(Explain any additional configuration or special customization for this hardware platform. Could be anything from BIOS settings to assigning proper media key functionality.)

=== Example 1 ===

(Example: Do this in order to get these keys working.)

== Troubleshooting ==

(Optional section.)

(Troubleshoot issues in this section. Separate issues by best describing the error with a new section name. Remove this section and subsections if no issues are known.)

=== Issue 1 ===

When X happens, Y is how you fix it.

== See also ==

(Optional section.)

* [[Article_name]] - (Link to related Gentoo Wiki articles using bullet points for each link in this section; each link should be local to the Wiki. Use a dash to separate the link from a reason why the link was decided upon.)

== External resources ==

(Optional section.)

* (Link to external resources (outside the Wiki) using bullet points in this section. It is common for the information in this section to full sentences that are links.)

== References ==

(Optional section. Remove this section if references are not used. This section is used to cite factual information. This information is found outside the Gentoo Wiki and used to back up truth claims. The actual references themselves still be littered throughout the main article.)

{{reflist}}

[[Category:Embedded_systems]]

See also