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