diff options
Diffstat (limited to 'meta-fri2/README')
-rw-r--r-- | meta-fri2/README | 339 |
1 files changed, 0 insertions, 339 deletions
diff --git a/meta-fri2/README b/meta-fri2/README deleted file mode 100644 index 6e90c335..00000000 --- a/meta-fri2/README +++ /dev/null | |||
@@ -1,339 +0,0 @@ | |||
1 | This README file contains information on building the meta-fri2 BSP | ||
2 | layer and booting the images contained in the /binary directory. | ||
3 | Please see the corresponding sections below for details. | ||
4 | |||
5 | The Fish River Island II BSP supports the Kontron M2M Smart Services | ||
6 | Developer Kit, as described here: | ||
7 | |||
8 | http://us.kontron.com/products/systems+and+platforms/m2m/m2m+smart+services+developer+kit.html | ||
9 | |||
10 | The 'Queens Bay' platform consists of the Intel Atom E640T processor plus the | ||
11 | Intel EG20T Platform Controller Hub (Tunnel Creek + Topcliff). The Fish River | ||
12 | Island II includes a variety of communications options and other | ||
13 | machine-to-machine (m2m) capabilities. | ||
14 | |||
15 | Information on all Intel embedded platforms can be found here: | ||
16 | |||
17 | http://www.intel.com/p/en_US/embedded/hwsw/hardware | ||
18 | |||
19 | |||
20 | Yocto Project Compatible | ||
21 | ======================== | ||
22 | |||
23 | This BSP is compatible with the Yocto Project as per the requirements | ||
24 | listed here: | ||
25 | |||
26 | https://www.yoctoproject.org/webform/yocto-project-compatible-registration | ||
27 | |||
28 | |||
29 | Dependencies | ||
30 | ============ | ||
31 | |||
32 | This layer depends on: | ||
33 | |||
34 | URI: git://git.openembedded.org/bitbake | ||
35 | branch: master | ||
36 | |||
37 | URI: git://git.openembedded.org/openembedded-core | ||
38 | layers: meta | ||
39 | branch: master | ||
40 | |||
41 | URI: git://git.yoctoproject.org/meta-intel | ||
42 | layers: intel | ||
43 | branch: master | ||
44 | |||
45 | |||
46 | Patches | ||
47 | ======= | ||
48 | |||
49 | Please submit any patches against this BSP to the meta-intel mailing list | ||
50 | (meta-intel@yoctoproject.org) and cc: the maintainer: | ||
51 | |||
52 | Maintainer: Darren Hart <dvhart@linux.intel.com> | ||
53 | |||
54 | Please see the meta-intel/MAINTAINERS file for more details. | ||
55 | |||
56 | |||
57 | Table of Contents | ||
58 | ================= | ||
59 | |||
60 | I. Building the meta-fri2 BSP layer | ||
61 | II. Booting the images in /binary | ||
62 | III. Device Notes | ||
63 | a. BIOS and Firmware | ||
64 | b. Serial Port | ||
65 | c. HDMI | ||
66 | d. Power Reset | ||
67 | e. Accelerometer | ||
68 | f. GPIO | ||
69 | g. MMC | ||
70 | h. 802.11 | ||
71 | i. 802.15.4 | ||
72 | j. Audio | ||
73 | k. Optional Devices | ||
74 | IV. Known Issues | ||
75 | a. EFI boot fails | ||
76 | b. Client USB is disabled | ||
77 | c. Audio over secondary HDMI port only | ||
78 | V. Additional Resources | ||
79 | |||
80 | |||
81 | I. Building the meta-fri2 BSP layer | ||
82 | =================================== | ||
83 | |||
84 | In order to build an image with BSP support for a given release, you | ||
85 | need to download the corresponding BSP tarball from the 'Board Support | ||
86 | Package (BSP) Downloads' page of the Yocto Project website. | ||
87 | |||
88 | Having done that, and assuming you extracted the BSP tarball contents | ||
89 | at the top-level of your yocto build tree, you can build an fri2 image | ||
90 | by adding the location of the meta-intel and meta-fri2 layers to | ||
91 | bblayers.conf, e.g.: | ||
92 | |||
93 | yocto/meta-intel \ | ||
94 | yocto/meta-intel/meta-fri2 \ | ||
95 | |||
96 | The meta-fri2 layer contains support for fri2-noemgd machine configuration. | ||
97 | The previously supported fri2 machine with the proprietary EMGD graphics | ||
98 | driver has been retired. The 'fri2-noemgd' machine configuration uses | ||
99 | the open source 'vesa' kernel driver. | ||
100 | |||
101 | To enable the layer add the following to the local.conf file: | ||
102 | |||
103 | MACHINE ?= "fri2-noemgd" | ||
104 | |||
105 | You should then be able to build an fri2 image as such: | ||
106 | |||
107 | $ source oe-init-build-env | ||
108 | $ bitbake core-image-sato | ||
109 | |||
110 | At the end of a successful build, you should have a live image that | ||
111 | you can boot from a USB flash drive (see instructions on how to do | ||
112 | that below, in the section 'Booting the images from /binary'). | ||
113 | |||
114 | As an alternative to downloading the BSP tarball, you can also work | ||
115 | directly from the meta-intel git repository. For each BSP in the | ||
116 | 'meta-intel' repository, there are multiple branches, one | ||
117 | corresponding to each major release starting with 'laverne' (0.90), in | ||
118 | addition to the latest code which tracks the current master (note that | ||
119 | not all BSPs are present in every release). Instead of extracting a | ||
120 | BSP tarball at the top level of your yocto build tree, you can | ||
121 | equivalently check out the appropriate branch from the meta-intel | ||
122 | repository at the same location. | ||
123 | |||
124 | |||
125 | II. Booting the images in /binary | ||
126 | ================================= | ||
127 | |||
128 | This BSP contains bootable live images, which can be used to directly | ||
129 | boot Yocto off of a USB flash drive. | ||
130 | |||
131 | Under Linux, insert a USB flash drive. Assuming the USB flash drive | ||
132 | takes device /dev/sdf, use dd to copy the live image to it. For | ||
133 | example: | ||
134 | |||
135 | # dd if=core-image-sato-fri2-noemgd.hddimg of=/dev/sdf | ||
136 | # sync | ||
137 | # eject /dev/sdf | ||
138 | |||
139 | This should give you a bootable USB flash device. Insert the device | ||
140 | into one of the USB host ports on the target, and power on. This | ||
141 | should result in a system booted to the Sato graphical desktop. | ||
142 | |||
143 | If you want a terminal, use the arrows at the top of the UI to move to | ||
144 | different pages of available applications, one of which is named | ||
145 | 'Terminal'. Clicking that should give you a root terminal. | ||
146 | |||
147 | If you want to ssh into the system, you can use the root terminal to | ||
148 | ifconfig the IP address and use that to ssh in. The root password is | ||
149 | empty, so to log in type 'root' for the user name and hit 'Enter' at | ||
150 | the Password prompt: and you should be in. | ||
151 | |||
152 | If instead of a live image, you would like to prepare an EFI bootable | ||
153 | partitioned image, use the mkefidisk.sh script provided in the scripts | ||
154 | directory of this BSP. Future versions of the images have an EFI | ||
155 | installer integrated into the live image. | ||
156 | |||
157 | ---- | ||
158 | |||
159 | If you find you're getting corrupt images on the USB (it doesn't show | ||
160 | the syslinux boot: prompt, or the boot: prompt contains strange | ||
161 | characters), try doing this first: | ||
162 | |||
163 | # dd if=/dev/zero of=/dev/sdf bs=1M count=512 | ||
164 | |||
165 | |||
166 | III. Device Notes | ||
167 | ================================ | ||
168 | a. BIOS and Firmware | ||
169 | |||
170 | Units provided from the Yocto Project Fish River Island 2 Giveaway | ||
171 | Program are preconfigured with the Intel provided Fast Boot EFI | ||
172 | firmware. This firmware will search the available devices (USB, SD, | ||
173 | and mSATA) for a valid EFI payload at "EFI\BOOT\BOOTIA32.EFI". If it | ||
174 | fails to find one, it will launch the EFI shell and optionally execute | ||
175 | a "startup.nsh" script if it finds the script on the available storage | ||
176 | devices. It searches the devices in the following order: USB, SD, | ||
177 | mSATA. | ||
178 | |||
179 | Units acquired via other channels may have the Kontron supplied APTIO | ||
180 | (AMI) BIOS. This is a PCBIOS and EFI firmware with a traditional BIOS | ||
181 | configuration menu which can be used to define a variety of boot | ||
182 | configurations. | ||
183 | |||
184 | b. Serial Port | ||
185 | -------------- | ||
186 | The FRI2 has an optional serial daughter card providing a serial | ||
187 | console via the micro-USB port on the top of the device adjacent the | ||
188 | SIM card slot. | ||
189 | |||
190 | The UART from the EG20T is connected to a TI UART-to-USB device | ||
191 | (TUSB3410) which appears as a serial port on the host computer. From a | ||
192 | Linux host, load the driver with the following options: | ||
193 | |||
194 | # modprobe ti_usb_3410_5052 vendor_3410=0x0451 product_3410=0x5053 | ||
195 | |||
196 | In future versions of the Linux kernel (3.4 and later), the | ||
197 | vendor and product codes are detected automatically. | ||
198 | |||
199 | When you power on your FRI2, your host will discover a serial device | ||
200 | and name it /dev/ttyUSB0 (or similar). You can communicate with this | ||
201 | device at 115200 8N1 using your preferred terminal emulator. | ||
202 | |||
203 | If using the Intel provided Fast Boot EFI firmware, no additional | ||
204 | configuration is required. If using the APTIO (AMI) BIOS, use the | ||
205 | following settings to configure console redirection in the BIOS menu: | ||
206 | |||
207 | Advanced | ||
208 | Serial Port Console Redirection | ||
209 | COM2 | ||
210 | Console Redirection [Enabled] | ||
211 | Console Redirection Settings | ||
212 | Terminal Type [ANSI] | ||
213 | Bits per second [115200] | ||
214 | Data Bits [8] | ||
215 | Parity [None] | ||
216 | Stop Bits [1] | ||
217 | Flow Control [None] | ||
218 | Recorder Mode [Disabled] | ||
219 | Resolution 100x31 [Disabled] | ||
220 | Legacy OS Redirection [80x24] | ||
221 | |||
222 | c. HDMI | ||
223 | ------- | ||
224 | The FRI2 has two micro HDMI ports. For the Intel provided Fast Boot | ||
225 | EFI firmware, the one closest to the bottom of the device is the | ||
226 | primary display. For the APTIO (AMI) BIOS, the jack nearest the 1/8" | ||
227 | audio jacks is the primary display. | ||
228 | |||
229 | d. Power Reset | ||
230 | -------------- | ||
231 | The recessed button adjacent the LEDs on the top of the device is a | ||
232 | power reset button. | ||
233 | |||
234 | e. Accelerometer | ||
235 | ---------------- | ||
236 | The LIS331DLH accelerometer is connected to the I2C bus on the CPLD on | ||
237 | the compute module. The driver for this chip is under active | ||
238 | development and will be included in the BSP once completed. | ||
239 | |||
240 | f. GPIO | ||
241 | ------- | ||
242 | The FRI2 has two I2C PCA555x GPIO devices used for internal control | ||
243 | signals. These have not been exposed in the current release of the | ||
244 | BSP, but may be in the future. Regardless, these would not provide | ||
245 | general purpose IO with which to read or drive additional signals. | ||
246 | |||
247 | g. MMC | ||
248 | ------ | ||
249 | The FRI2 provides two microSD card MMC devices. One is located | ||
250 | adjacent the 1/8" audio jacks, another is located on the board inside | ||
251 | the chassis. These devices can be used to boot the device, or as | ||
252 | secondary storage. | ||
253 | |||
254 | h. 802.11 | ||
255 | --------- | ||
256 | The Intel Corporation Centrino Advanced-N 6205 that ships with the | ||
257 | FRI2 is supported. You can use connman-gnome to configures the | ||
258 | interface. | ||
259 | |||
260 | i. 802.15.4 | ||
261 | ----------- | ||
262 | The TI CC2531 802.15.4 radio is a USB ACM modem. The MAC is enabled by | ||
263 | issuing the following command: | ||
264 | |||
265 | # echo J > /dev/ttyACM0 | ||
266 | |||
267 | The bank of 3 LEDs nearest the power reset button will change if this | ||
268 | command is executed successfully. If you have a 3G modem installed, | ||
269 | the 802.15.4 device may appear as /dev/ttyACM3 instead. | ||
270 | |||
271 | No further testing or integration has been done. | ||
272 | |||
273 | j. Audio | ||
274 | -------------------- | ||
275 | The FRI2 has an 1/8" analog output (nearest the antennae), a line-in | ||
276 | input below that, as well as SPDIF over HDMI. These can be tested | ||
277 | using the alsa-utils package. The aplay -l command will list both | ||
278 | playback devices: | ||
279 | |||
280 | # aplay -l | ||
281 | **** List of PLAYBACK Hardware Devices **** | ||
282 | card 0: MID [HDA Intel MID], device 0: ALC262 Analog [ALC262 Analog] | ||
283 | Subdevices: 1/1 | ||
284 | Subdevice #0: subdevice #0 | ||
285 | card 0: MID [HDA Intel MID], device 3: ALC262 Digital [ALC262 Digital] | ||
286 | Subdevices: 1/1 | ||
287 | Subdevice #0: subdevice #0 | ||
288 | |||
289 | Using a sample WAV file, you can use aplay to play to either device: | ||
290 | |||
291 | Over analog: | ||
292 | # aplay -D plughw:0,0 sample.wav | ||
293 | |||
294 | Over HDMI: | ||
295 | # aplay -D plughw:0,3 sample.wav | ||
296 | |||
297 | |||
298 | k. Optional Devices | ||
299 | ------------------- | ||
300 | The FRI2 has two mini-PCIe slots internally. The device ships with a | ||
301 | half-length wireless card installed. This can be replaced with a | ||
302 | wireless + bluetooth card. The other slot is available for use with | ||
303 | cellular cards or mSATA SSDs. | ||
304 | |||
305 | The Ericsson F5521gw 3G modem has been verifed with the FRI2 images. | ||
306 | Note that the connman-gnome UI does not allow for configuring the | ||
307 | cellular interface. The ofono-tests package can be used to configure | ||
308 | the modem and bring up an interface. | ||
309 | |||
310 | |||
311 | IV. Known Issues | ||
312 | ---------------- | ||
313 | a. EFI | ||
314 | ------ | ||
315 | The APTIO (AMI) BIOS does not yet boot the EFI payload provided on the | ||
316 | FRI2 live image. This is a known issue under investigation. If using | ||
317 | this firmware, boot using PCBIOS mode, rather than EFI. The Intel | ||
318 | provided Fast Boot EFI firmware will boot the EFI payload. | ||
319 | |||
320 | b. Client USB is disabled | ||
321 | ------------------------- | ||
322 | The micro-USB port adjacent the primary HDMI port is intended for Client | ||
323 | USB functionality, but is not supported on current revisions of the | ||
324 | device. | ||
325 | |||
326 | c. Audio over secondary HDMI port only | ||
327 | -------------------------------------- | ||
328 | While audio over HDMI has been shown to work, it seems to only work over | ||
329 | the secondary (bottom-most) HDMI port. There does not appear to be a | ||
330 | deterministic way of getting the device to output the signal (video and | ||
331 | audio) over the secondary port. | ||
332 | |||
333 | |||
334 | V. Additional Resources | ||
335 | ----------------------- | ||
336 | In addition to this README, please see the following wiki page for tips | ||
337 | on using the FRI2 with the Yocto Project: | ||
338 | |||
339 | https://wiki.yoctoproject.org/wiki/BSPs/FRI2 | ||