summaryrefslogtreecommitdiffstats
path: root/meta-fri2
diff options
context:
space:
mode:
authorDarren Hart <dvhart@linux.intel.com>2012-12-06 02:29:02 (GMT)
committerDarren Hart <dvhart@linux.intel.com>2012-12-06 02:29:02 (GMT)
commit818e6ba129e7dc68d392f191b813529d387c1ae0 (patch)
treec66fd8db8fa4b0ba58243f13804fb9e03a0e3148 /meta-fri2
parent34c77e73566f641037ae03312845bd51d343e97e (diff)
downloadmeta-intel-818e6ba129e7dc68d392f191b813529d387c1ae0.tar.gz
fri2: README update
Update the README with various changes that somehow never made it in prior to the last release. These include details on the Intel provided Fast Boot EFI firmware, known issues, and de-versioning of the EMGD licensing configuration variables. Signed-off-by: Darren Hart <dvhart@linux.intel.com>
Diffstat (limited to 'meta-fri2')
-rw-r--r--meta-fri2/README127
1 files changed, 77 insertions, 50 deletions
diff --git a/meta-fri2/README b/meta-fri2/README
index b90613d..8c4d567 100644
--- a/meta-fri2/README
+++ b/meta-fri2/README
@@ -1,5 +1,5 @@
1This README file contains information on building the meta-fri2 BSP 1This README file contains information on building the meta-fri2 BSP
2layer, and booting the images contained in the /binary directory. 2layer and booting the images contained in the /binary directory.
3Please see the corresponding sections below for details. 3Please see the corresponding sections below for details.
4 4
5The Fish River Island II BSP supports the Kontron M2M Smart Services 5The Fish River Island II BSP supports the Kontron M2M Smart Services
@@ -59,20 +59,22 @@ Table of Contents
59 I. Building the meta-fri2 BSP layer 59 I. Building the meta-fri2 BSP layer
60 II. Booting the images in /binary 60 II. Booting the images in /binary
61III. Device Notes 61III. Device Notes
62 a. Serial Port 62 a. BIOS and Firmware
63 b. HDMI 63 b. Serial Port
64 c. Power Reset 64 c. HDMI
65 d. Accelerometer 65 d. Power Reset
66 e. GPIO 66 e. Accelerometer
67 f. MMC 67 f. GPIO
68 g. 802.11 68 g. MMC
69 h. 802.15.4 69 h. 802.11
70 i. Audio 70 i. 802.15.4
71 j. Optional devices 71 j. Audio
72 k. Optional Devices
72 IV. Known Issues 73 IV. Known Issues
73 a. EFI boot fails 74 a. EFI boot fails
74 b. Client USB is disabled 75 b. Client USB is disabled
75 c. Audio over secondary HDMI port only 76 c. Audio over secondary HDMI port only
77 V. Additional Resources
76 78
77 79
78I. Building the meta-fri2 BSP layer 80I. Building the meta-fri2 BSP layer
@@ -93,7 +95,7 @@ bblayers.conf, e.g.:
93The meta-fri2 layer contains support for two different machine 95The meta-fri2 layer contains support for two different machine
94configurations. These configurations are identical except for the fact 96configurations. These configurations are identical except for the fact
95that the one prefixed with 'fri2' makes use of the Intel-proprietary 97that the one prefixed with 'fri2' makes use of the Intel-proprietary
96EMGD 1.14 graphics driver, while the one prefixed with 'fri2-noemgd' 98EMGD graphics driver, while the one prefixed with 'fri2-noemgd'
97does not. 99does not.
98 100
99If you want to enable the layer that supports EMGD graphics add the 101If you want to enable the layer that supports EMGD graphics add the
@@ -103,12 +105,12 @@ following to the local.conf file:
103 105
104The 'fri2' machine includes the emgd-driver-bin package, which has a 106The 'fri2' machine includes the emgd-driver-bin package, which has a
105proprietary license that must be whitelisted by adding the string 107proprietary license that must be whitelisted by adding the string
106"license_emgd-driver-bin_1.14" to the LICENSE_FLAGS_WHITELIST variable 108"license_emgd-driver-bin" to the LICENSE_FLAGS_WHITELIST variable in
107in your local.conf. For example: 109your local.conf. For example:
108 110
109 LICENSE_FLAGS_WHITELIST = "license_emgd-driver-bin_1.14" 111 LICENSE_FLAGS_WHITELIST = "license_emgd-driver-bin"
110 112
111If you want to enable the layer that does not support EMGD graphics 113If you want to enable the layer that does not support EMGD graphics,
112add the following to the local.conf file: 114add the following to the local.conf file:
113 115
114 MACHINE ?= "fri2-noemgd" 116 MACHINE ?= "fri2-noemgd"
@@ -128,7 +130,7 @@ added to the the LICENSE_FLAGS_WHITELIST variable in your local.conf.
128 130
129For example: 131For example:
130 132
131 LICENSE_FLAGS_WHITELIST = "license_emgd-driver-bin_1.14 commercial" 133 LICENSE_FLAGS_WHITELIST = "license_emgd-driver-bin commercial"
132 134
133The reason this is needed is to prevent the image from including 135The reason this is needed is to prevent the image from including
134anything that might violate the license terms of the packages used to 136anything that might violate the license terms of the packages used to
@@ -175,6 +177,11 @@ ifconfig the IP address and use that to ssh in. The root password is
175empty, so to log in type 'root' for the user name and hit 'Enter' at 177empty, so to log in type 'root' for the user name and hit 'Enter' at
176the Password prompt: and you should be in. 178the Password prompt: and you should be in.
177 179
180If instead of a live image, you would like to prepare an EFI bootable
181partitioned image, use the mkefidisk.sh script provided in the scripts
182directory of this BSP. Future versions of the images have an EFI
183installer integrated into the live image.
184
178---- 185----
179 186
180If you find you're getting corrupt images on the USB (it doesn't show 187If you find you're getting corrupt images on the USB (it doesn't show
@@ -186,10 +193,26 @@ characters), try doing this first:
186 193
187III. Device Notes 194III. Device Notes
188================================ 195================================
189a. Serial Port 196a. BIOS and Firmware
197
198Units provided from the Yocto Project Fish River Island 2 Giveaway
199Program are preconfigured with the Intel provided Fast Boot EFI
200firmware. This firmware will search the available devices (USB, SD,
201and mSATA) for a valid EFI payload at "EFI\BOOT\BOOTIA32.EFI". If it
202fails to find one, it will launch the EFI shell and optionally execute
203a "startup.nsh" script if it finds the script on the available storage
204devices. It searches the devices in the following order: USB, SD,
205mSATA.
206
207Units acquired via other channels may have the Kontron supplied APTIO
208(AMI) BIOS. This is a PCBIOS and EFI firmware with a traditional BIOS
209configuration menu which can be used to define a variety of boot
210configurations.
211
212b. Serial Port
190-------------- 213--------------
191The FRI2 has an optional serial daughter card providing a serial 214The FRI2 has an optional serial daughter card providing a serial
192console via the micro-USB port on the top of the device adjascent the 215console via the micro-USB port on the top of the device adjacent the
193SIM card slot. 216SIM card slot.
194 217
195The UART from the EG20T is connected to a TI UART-to-USB device 218The UART from the EG20T is connected to a TI UART-to-USB device
@@ -205,9 +228,9 @@ When you power on your FRI2, your host will discover a serial device
205and name it /dev/ttyUSB0 (or similar). You can communicate with this 228and name it /dev/ttyUSB0 (or similar). You can communicate with this
206device at 115200 8N1 using your preferred terminal emulator. 229device at 115200 8N1 using your preferred terminal emulator.
207 230
208In order to redirect the BIOS console to the serial port, you may need 231If using the Intel provided Fast Boot EFI firmware, no additional
209to set up console redirection in the BIOS menu. The serial port is 232configuration is required. If using the APTIO (AMI) BIOS, use the
210referred to as COM2 in the BIOS. 233following settings to configure console redirection in the BIOS menu:
211 234
212 Advanced 235 Advanced
213 Serial Port Console Redirection 236 Serial Port Console Redirection
@@ -224,50 +247,45 @@ referred to as COM2 in the BIOS.
224 Resolution 100x31 [Disabled] 247 Resolution 100x31 [Disabled]
225 Legacy OS Redirection [80x24] 248 Legacy OS Redirection [80x24]
226 249
227Note that the UART clock is configured at 48MHz in the firmware. This 250c. HDMI
228will cause problems with software assuming a typical 1.8 MHz clock.
229The Linux kernel pch-uart driver is aware of the clock, but Syslinux,
230for example, is not. For software expecting a typical clock, directing
231them to use a BAUD of 3318 (rather than 115200) can work around the
232problem.
233
234b. HDMI
235------- 251-------
236The FRI2 has two micro HDMI ports. The one closest to the 1/8" audio 252The FRI2 has two micro HDMI ports. For the Intel provided Fast Boot
237jacks is the primary display. 253EFI firmware, the one closest to the bottom of the device is the
254primary display. For the APTIO (AMI) BIOS, the jack nearest the 1/8"
255audio jacks is the primary display.
238 256
239c. Power Reset 257d. Power Reset
240-------------- 258--------------
241The recessed button adjacent the LEDs on the top of the device is a 259The recessed button adjacent the LEDs on the top of the device is a
242power reset button. 260power reset button.
243 261
244d. Accelerometer 262e. Accelerometer
245---------------- 263----------------
246The LIS331DLH accelerometer is connected to the I2C bus on the CPLD on 264The LIS331DLH accelerometer is connected to the I2C bus on the CPLD on
247the compute module. The driver for this chip is under active 265the compute module. The driver for this chip is under active
248development and will be included in the BSP once completed. 266development and will be included in the BSP once completed.
249 267
250e. GPIO 268f. GPIO
251------- 269-------
252The FRI2 has two I2C PCA555x GPIO devices used for internal control 270The FRI2 has two I2C PCA555x GPIO devices used for internal control
253signals. These have not been exposed in the current release of the 271signals. These have not been exposed in the current release of the
254BSP, but may be in the future. Regardless, these would not provide 272BSP, but may be in the future. Regardless, these would not provide
255general purpose IO with which to read or drive additional signals. 273general purpose IO with which to read or drive additional signals.
256 274
257f. MMC 275g. MMC
258------ 276------
259The FRI2 provides two microSD card MMC devices. One is located 277The FRI2 provides two microSD card MMC devices. One is located
260adjacent the 1/8" audio jacks, another is located on the board inside 278adjacent the 1/8" audio jacks, another is located on the board inside
261the chassis. These devices can be used to boot the device, or as 279the chassis. These devices can be used to boot the device, or as
262secondary storage. 280secondary storage.
263 281
264g. 802.11 282h. 802.11
265--------- 283---------
266The Intel Corporation Centrino Advanced-N 6205 that ships with the 284The Intel Corporation Centrino Advanced-N 6205 that ships with the
267FRI2 is supported. You can use connman-gnome to configures the 285FRI2 is supported. You can use connman-gnome to configures the
268interface. 286interface.
269 287
270h. 802.15.4 288i. 802.15.4
271----------- 289-----------
272The TI CC2531 802.15.4 radio is a USB ACM modem. The MAC is enabled by 290The TI CC2531 802.15.4 radio is a USB ACM modem. The MAC is enabled by
273issuing the following command: 291issuing the following command:
@@ -280,12 +298,12 @@ the 802.15.4 device may appear as /dev/ttyACM3 instead.
280 298
281No further testing or integration has been done. 299No further testing or integration has been done.
282 300
283i. Audio 301j. Audio
284-------------------- 302--------------------
285The FRI2 has an 1/8" analog output (nearest the antennae), a line-in 303The FRI2 has an 1/8" analog output (nearest the antennae), a line-in
286input below that, as well as SPDIF over HDMI. These can be tested 304input below that, as well as SPDIF over HDMI. These can be tested
287using the alsa-utils package. aplay -l will list both playback 305using the alsa-utils package. The aplay -l command will list both
288devices: 306playback devices:
289 307
290# aplay -l 308# aplay -l
291**** List of PLAYBACK Hardware Devices **** 309**** List of PLAYBACK Hardware Devices ****
@@ -305,7 +323,7 @@ Over HDMI:
305# aplay -D plughw:0,3 sample.wav 323# aplay -D plughw:0,3 sample.wav
306 324
307 325
308j. Optional Devices 326k. Optional Devices
309------------------- 327-------------------
310The FRI2 has two mini-PCIe slots internally. The device ships with a 328The FRI2 has two mini-PCIe slots internally. The device ships with a
311half-length wireless card installed. This can be replaced with a 329half-length wireless card installed. This can be replaced with a
@@ -322,19 +340,28 @@ IV. Known Issues
322---------------- 340----------------
323a. EFI 341a. EFI
324------ 342------
325The FRI2 firmware can boot to an EFI shell. It does not yet boot the 343The APTIO (AMI) BIOS does not yet boot the EFI payload provided on the
326EFI payload provided on the FRI2 live image. This is a known issue 344FRI2 live image. This is a known issue under investigation. If using
327under investigation. 345this firmware, boot using PCBIOS mode, rather than EFI. The Intel
346provided Fast Boot EFI firmware will boot the EFI payload.
328 347
329b. Client USB is disabled 348b. Client USB is disabled
330------------------------- 349-------------------------
331The micro-USB port adjacent the primary HDMI port is intended for 350The micro-USB port adjacent the primary HDMI port is intended for Client
332Client USB functionality, but is not supported on current revisions of 351USB functionality, but is not supported on current revisions of the
333the device. 352device.
334 353
335c. Audio over secondary HDMI port only 354c. Audio over secondary HDMI port only
336-------------------------------------- 355--------------------------------------
337While audio over HDMI has been shown to work, it seems to only work over 356While audio over HDMI has been shown to work, it seems to only work over
338the secondary (bottom-most) HDMI port. There does not appear to be a 357the secondary (bottom-most) HDMI port. There does not appear to be a
339deterministic way of getting the device to output the signal (video and audio) 358deterministic way of getting the device to output the signal (video and
340over the secondary port. 359audio) over the secondary port.
360
361
362V. Additional Resources
363-----------------------
364In addition to this README, please see the following wiki page for tips
365on using the FRI2 with the Yocto Project:
366
367https://wiki.yoctoproject.org/wiki/BSPs/FRI2