summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDarren Hart <dvhart@linux.intel.com>2012-07-27 18:40:53 (GMT)
committerDarren Hart <dvhart@linux.intel.com>2012-07-30 23:24:01 (GMT)
commita1a32b20ee7677f05cc01ab7428f256127657e98 (patch)
tree0c36a1f93b952e6953cc44f1b64c088c3da1863b
parentc10b3557ee6c9d48be93791b1481fe7c14d990bb (diff)
downloadmeta-intel-a1a32b20ee7677f05cc01ab7428f256127657e98.tar.gz
fri2: Update README
o Technical writing feedback from Scott Rifenbark o Updated and refactored device notes, including a new section on BIOS and firmware o Added dim secondary HDMI port to known issues Signed-off-by: Darren Hart <dvhart@linux.intel.com> CC: Scott Rifenbark <scott.m.rifenbark@intel.com>
-rw-r--r--meta-fri2/README130
1 files changed, 85 insertions, 45 deletions
diff --git a/meta-fri2/README b/meta-fri2/README
index 2208392..a93e76f 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
@@ -50,20 +50,23 @@ Table of Contents
50 I. Building the meta-fri2 BSP layer 50 I. Building the meta-fri2 BSP layer
51 II. Booting the images in /binary 51 II. Booting the images in /binary
52III. Device Notes 52III. Device Notes
53 a. Serial Port 53 a. BIOS and Firmware
54 b. HDMI 54 b. Serial Port
55 c. Power Reset 55 c. HDMI
56 d. Accelerometer 56 d. Power Reset
57 e. GPIO 57 e. Accelerometer
58 f. MMC 58 f. GPIO
59 g. 802.11 59 g. MMC
60 h. 802.15.4 60 h. 802.11
61 i. Audio 61 i. 802.15.4
62 j. Optional devices 62 j. Audio
63 k. Optional Devices
63 IV. Known Issues 64 IV. Known Issues
64 a. EFI boot fails 65 a. EFI boot fails
65 b. Client USB is disabled 66 b. Client USB is disabled
66 c. Audio over secondary HDMI port only 67 c. Audio over secondary HDMI port only
68 d. Secondary HDMI port is dim under X
69 V. Additional Resources
67 70
68 71
69I. Building the meta-fri2 BSP layer 72I. Building the meta-fri2 BSP layer
@@ -99,7 +102,7 @@ in your local.conf. For example:
99 102
100 LICENSE_FLAGS_WHITELIST = "license_emgd-driver-bin_1.10" 103 LICENSE_FLAGS_WHITELIST = "license_emgd-driver-bin_1.10"
101 104
102If you want to enable the layer that does not support EMGD graphics 105If you want to enable the layer that does not support EMGD graphics,
103add the following to the local.conf file: 106add the following to the local.conf file:
104 107
105 MACHINE ?= "fri2-noemgd" 108 MACHINE ?= "fri2-noemgd"
@@ -151,6 +154,11 @@ ifconfig the IP address and use that to ssh in. The root password is
151empty, so to log in type 'root' for the user name and hit 'Enter' at 154empty, so to log in type 'root' for the user name and hit 'Enter' at
152the Password prompt: and you should be in. 155the Password prompt: and you should be in.
153 156
157If instead of a live image, you would like to prepare an EFI bootable
158partitioned image, use the mkefidisk.sh script provided in the scripts
159directory of this BSP. Future versions of the images have an EFI
160installer integrated into the live image.
161
154---- 162----
155 163
156If you find you're getting corrupt images on the USB (it doesn't show 164If you find you're getting corrupt images on the USB (it doesn't show
@@ -162,10 +170,26 @@ characters), try doing this first:
162 170
163III. Device Notes 171III. Device Notes
164================================ 172================================
165a. Serial Port 173a. BIOS and Firmware
174
175Units provided from the Yocto Project Fish River Island 2 Giveaway
176Program are preconfigured with the Intel provided Fast Boot firmware.
177This firmware will search the available devices (USB, SD, and mSATA) for
178a valid EFI payload at "EFI\BOOT\BOOTIA32.EFI". If it fails to find one,
179it will launch the EFI shell and optionally execute a "startup.nsh"
180script if it finds the script on the available storage devices. It
181searches the devices in the following order: USB, SD, mSATA.
182
183Units acquired via other channels may have the Kontron supplied APTIO
184(AMI) BIOS. This is a PCBIOS and EFI firmware with a traditional BIOS
185configuration menu which can be used to define a variety of boot
186configurations.
187
188
189b. Serial Port
166-------------- 190--------------
167The FRI2 has an optional serial daughter card providing a serial 191The FRI2 has an optional serial daughter card providing a serial
168console via the micro-USB port on the top of the device adjascent the 192console via the micro-USB port on the top of the device adjacent the
169SIM card slot. 193SIM card slot.
170 194
171The UART from the EG20T is connected to a TI UART-to-USB device 195The UART from the EG20T is connected to a TI UART-to-USB device
@@ -181,9 +205,9 @@ When you power on your FRI2, your host will discover a serial device
181and name it /dev/ttyUSB0 (or similar). You can communicate with this 205and name it /dev/ttyUSB0 (or similar). You can communicate with this
182device at 115200 8N1 using your preferred terminal emulator. 206device at 115200 8N1 using your preferred terminal emulator.
183 207
184In order to redirect the BIOS console to the serial port, you may need 208If using the Intel provided Fast Boot firmware, no additional
185to set up console redirection in the BIOS menu. The serial port is 209configuration is required. If using the APTIO (AMI) BIOS, use the
186referred to as COM2 in the BIOS. 210following settings to configure console redirection in the BIOS menu:
187 211
188 Advanced 212 Advanced
189 Serial Port Console Redirection 213 Serial Port Console Redirection
@@ -200,50 +224,46 @@ referred to as COM2 in the BIOS.
200 Resolution 100x31 [Disabled] 224 Resolution 100x31 [Disabled]
201 Legacy OS Redirection [80x24] 225 Legacy OS Redirection [80x24]
202 226
203Note that the UART clock is configured at 48MHz in the firmware. This
204will cause problems with software assuming a typical 1.8 MHz clock.
205The Linux kernel pch-uart driver is aware of the clock, but Syslinux,
206for example, is not. For software expecting a typical clock, directing
207them to use a BAUD of 3318 (rather than 115200) can work around the
208problem.
209 227
210b. HDMI 228c. HDMI
211------- 229-------
212The FRI2 has two micro HDMI ports. The one closest to the 1/8" audio 230The FRI2 has two micro HDMI ports. For the Intel provided Fast Boot
213jacks is the primary display. 231firmware, the one closest to the bottom of the device is the primary
232display. For the APTIO (AMI) BIOS, the jack nearest the 1/8" audio jacks
233is the primary display.
214 234
215c. Power Reset 235d. Power Reset
216-------------- 236--------------
217The recessed button adjacent the LEDs on the top of the device is a 237The recessed button adjacent the LEDs on the top of the device is a
218power reset button. 238power reset button.
219 239
220d. Accelerometer 240e. Accelerometer
221---------------- 241----------------
222The LIS331DLH accelerometer is connected to the I2C bus on the CPLD on 242The LIS331DLH accelerometer is connected to the I2C bus on the CPLD on
223the compute module. The driver for this chip is under active 243the compute module. The driver for this chip is under active
224development and will be included in the BSP once completed. 244development and will be included in the BSP once completed.
225 245
226e. GPIO 246f. GPIO
227------- 247-------
228The FRI2 has two I2C PCA555x GPIO devices used for internal control 248The FRI2 has two I2C PCA555x GPIO devices used for internal control
229signals. These have not been exposed in the current release of the 249signals. These have not been exposed in the current release of the
230BSP, but may be in the future. Regardless, these do would not provide 250BSP, but may be in the future. Regardless, these do would not provide
231general purpose IO with which to read or drive additional signals. 251general purpose IO with which to read or drive additional signals.
232 252
233f. MMC 253g. MMC
234------ 254------
235The FRI2 provides two microSD card MMC devices. One is located 255The FRI2 provides two microSD card MMC devices. One is located
236adjacent the 1/8" audio jacks, another is located on the board inside 256adjacent the 1/8" audio jacks, another is located on the board inside
237the chassis. These devices can be used to boot the device, or as 257the chassis. These devices can be used to boot the device, or as
238secondary storage. 258secondary storage.
239 259
240g. 802.11 260h. 802.11
241--------- 261---------
242The Intel Corporation Centrino Advanced-N 6205 that ships with the 262The Intel Corporation Centrino Advanced-N 6205 that ships with the
243FRI2 is supported. You can use connman-gnome to configures the 263FRI2 is supported. You can use connman-gnome to configures the
244interface. 264interface.
245 265
246h. 802.15.4 266i. 802.15.4
247----------- 267-----------
248The TI CC2531 802.15.4 radio is a USB ACM modem. The MAC is enabled by 268The TI CC2531 802.15.4 radio is a USB ACM modem. The MAC is enabled by
249issuing the following command: 269issuing the following command:
@@ -256,11 +276,11 @@ the 802.15.4 device may appear as /dev/ttyACM3 instead.
256 276
257No further testing or integration has been done. 277No further testing or integration has been done.
258 278
259i. Audio 279j. Audio
260-------------------- 280--------------------
261The FRI2 has an 1/8" analog output (nearest the antennae), a line-in 281The FRI2 has an 1/8" analog output (nearest the antennae), a line-in
262input below that, as well as SPDIF over HDMI. These can be tested 282input below that, as well as SPDIF over HDMI. These can be tested
263using the alsa-utils package. aplay -l will list both playback 283using the alsa-utils package. The aplay -l command will list both playback
264devices: 284devices:
265 285
266# aplay -l 286# aplay -l
@@ -281,7 +301,7 @@ Over HDMI:
281# aplay -D plughw:0,3 sample.wav 301# aplay -D plughw:0,3 sample.wav
282 302
283 303
284j. Optional Devices 304k. Optional Devices
285------------------- 305-------------------
286The FRI2 has two mini-PCIe slots internally. The device ships with a 306The FRI2 has two mini-PCIe slots internally. The device ships with a
287half-length wireless card installed. This can be replaced with a 307half-length wireless card installed. This can be replaced with a
@@ -290,27 +310,47 @@ cellular cards or mSATA SSDs.
290 310
291The Ericsson F5521gw 3G modem has been verifed with the FRI2 images. 311The Ericsson F5521gw 3G modem has been verifed with the FRI2 images.
292Note that the connman-gnome UI does not allow for configuring the 312Note that the connman-gnome UI does not allow for configuring the
293cellular interface. The ofono-tests package can be used to configure 313cellular interface. The ofono-tests package can be used to configure the
294the modem and bring up an interface. 314modem and bring up an interface.
295 315
296 316
297IV. Known Issues 317IV. Known Issues
298---------------- 318----------------
299a. EFI 319a. EFI
300------ 320------
301The FRI2 firmware can boot to an EFI shell. It does not yet boot the 321The APTIO (AMI) BIOS does not yet boot the EFI payload provided on the
302EFI payload provided on the FRI2 live image. This is a known issue 322FRI2 live image. This is a known issue under investigation. If using
303under investigation. 323this firmware, boot using PCBIOS mode, rather than EFI. The Intel
324provided Fast Boot firmware will boot the EFI payload.
304 325
305b. Client USB is disabled 326b. Client USB is disabled
306------------------------- 327-------------------------
307The micro-USB port adjacent the primary HDMI port is intended for 328The micro-USB port adjacent the primary HDMI port is intended for Client
308Client USB functionality, but is not supported on current revisions of 329USB functionality, but is not supported on current revisions of the
309the device. 330device.
310 331
311c. Audio over secondary HDMI port only 332c. Audio over secondary HDMI port only
312-------------------------------------- 333--------------------------------------
313While audio over HDMI has been shown to work, it seems to only work over 334While audio over HDMI has been shown to work, it seems to only work over
314the secondary (bottom-most) HDMI port. There does not appear to be a 335the secondary (bottom-most) HDMI port. There does not appear to be a
315deterministic way of getting the device to output the signal (video and audio) 336deterministic way of getting the device to output the signal (video and
316over the secondary port. 337audio) over the secondary port.
338
339d. Secondary HDMI port is dim under X
340-------------------------------------
341The EMGD driver appears to display a dim image on the secondary
342(bottom-most) HDMI port. With the Intel provided Fast Boot firmware, the
343EFI shell and payload (including the Linux kernel messages and tty) are
344only displayed over the secondary HDMI port. For scenarios requiring a
345graphical display, the workaround is to connect the display to the
346primary HDMI port and boot unattended, or using the serial port if
347manual interaction is required. A software fix including an upgraded
348EMGD driver is planned for the 1.3 version of the BSP.
349
350
351V. Additional Resources
352-----------------------
353In addition to this README, please see the following wiki page for tips
354on using the FRI2 with the Yocto Project:
355
356https://wiki.yoctoproject.org/wiki/BSPs/FRI2