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