summaryrefslogtreecommitdiffstats
path: root/meta-isg/meta-crystalforest/README
diff options
context:
space:
mode:
Diffstat (limited to 'meta-isg/meta-crystalforest/README')
-rw-r--r--meta-isg/meta-crystalforest/README240
1 files changed, 240 insertions, 0 deletions
diff --git a/meta-isg/meta-crystalforest/README b/meta-isg/meta-crystalforest/README
new file mode 100644
index 0000000..4878105
--- /dev/null
+++ b/meta-isg/meta-crystalforest/README
@@ -0,0 +1,240 @@
1This README file contains information on building the meta-crystalforest
2BSP layer, and booting the images contained in the /binary directory.
3Please see the corresponding sections below for details.
4
5Overview of Intel Communication Product Offering
6------------------------------------------------
7
8The following platforms are supported on meta-intel dizzy branch ONLY:
9
10Crystal Forest/Server - Shumway reference platform configurations:
11processor: Intel Xeon E5-2600/E5-2400 (Sandy Bridge-based) or
12 Intel Xeon E5-2600v2/E5-2400v2 (Ivy Bridge-based)
13chipset: Intel Communication Chipset 8900-8920 Series (Cave Creek)
14url: http://www.intel.com/p/en_US/embedded/hwsw/hardware/xeon-e5-89xx/overview
15
16Crystal Forest/Gladden - Stargo reference platform configurations:
17processor: Intel Xeon E3-1125C/E3-1105C (Sandy Bridge-based) or
18 Intel Xeon E3-1125v2/E3-1105v2 (Ivy Bridge-based)
19chipset: Intel Communication Chipset 8900-8920 Series (Cave Creek)
20url: http://www.intel.com/p/en_US/embedded/hwsw/hardware/xeon-core-pentium-celeron-89xx/overview
21
22Highland Forest (Crystal Forest/Server Refresh) - Shumway reference platform configurations:
23processor: Intel Xeon E5-2600v2/E5-2400v2 (Ivy Bridge-based)
24chipset: Intel Communication Chipset 8925-8955 Series (Coleto Creek)
25url: https://www-ssl.intel.com/content/www/us/en/intelligent-systems/crystal-forest-server/xeon-e5-v2-89xx-chipset-ibd.html
26
27The following platform is supported on meta-intel fido branch and beyond.
28
29River Forest - Long Brook reference platform configurations:
30processor: Intel Xeon E5-2600v3/E5-2400v3 (Haswell EP-based)
31chipset: Intel Communication Chipset 8925-8955 Series (Coleto Creek)
32url: https://www-ssl.intel.com/content/www/my/en/embedded/products/river-forest/overview.html?wapkw=coleto
33
34All above four platforms use PCIe-based Matrox graphics card for display.
35
36More Information on all IntelĀ® embedded platforms can be found here:
37
38 http://www.intel.com/p/en_US/embedded/hwsw/hardware
39
40
41Yocto Project Compatible
42========================
43
44This BSP is compatible with the Yocto Project as per the requirements
45listed here:
46
47 https://www.yoctoproject.org/webform/yocto-project-compatible-registration
48
49Dependencies
50============
51
52This layer depends on:
53
54 URI: git://git.openembedded.org/bitbake
55 branch: master
56
57 URI: git://git.openembedded.org/openembedded-core
58 layers: meta
59 branch: master
60
61 URI: git://git.yoctoproject.org/meta-intel
62 layers: intel
63 branch: master
64
65
66Patches
67=======
68
69Please submit any patches against this BSP to the meta-intel mailing
70list (meta-intel@yoctoproject.org) and cc: the maintainer:
71
72Maintainer: Wu Chia Chuan <chia.chuan.wu@intel.com>
73
74Please see the meta-isg/MAINTAINERS file for more details.
75
76
77Table of Contents
78=================
79
80 I. Building the meta-crystalforest BSP layer
81 II. Booting the images in /binary
82III. Device Notes
83 a. Boot Loader
84 b. I/O drivers
85IV. Enabling Intel DPDK and QuickAssist Technology
86
87I. Building the meta-crystalforest BSP layer
88=======================================
89
90In order to build an image with BSP support for a given release, you
91need to download the corresponding BSP tarball from the 'Board Support
92Package (BSP) Downloads' page of the Yocto Project website.
93
94Having done that, and assuming you extracted the BSP tarball contents
95at the top-level of your yocto build tree, you can build a crystalforest
96image by adding the location of the meta-crystalforest layer to
97bblayers.conf, along with the meta-intel layer itself (to access
98common metadata shared between BSPs) e.g.:
99
100 yocto/meta-intel \
101 yocto/meta-intel/meta-isg/meta-crystalforest \
102
103Crystal Forest layer is meant for building both Crystal Forest Gladden
104and Crystal Forest Server platforms. By enabling Crystal Forest layer,
105the image you build is able to boot on both supported platforms.
106
107To enable the Crystal Forest layer, add the Crystal Forest MACHINE to
108build/local.conf:
109
110 MACHINE ?= "crystalforest"
111
112You should then be able to build a crystalforest image as such:
113
114 $ source oe-init-build-env
115 $ bitbake core-image-sato
116
117At the end of a successful build, you should have a live image that
118you can boot from a USB flash drive (see instructions on how to do
119that below, in the section 'Booting the images from /binary').
120
121The live image is located within build/tmp/deploy/images/<machine> folder.
122
123As an alternative to downloading the BSP tarball, you can also work
124directly from the meta-intel git repository. For each BSP in the
125'meta-intel' repository, there are multiple branches, one
126corresponding to each major release starting with 'laverne' (0.90), in
127addition to the latest code which tracks the current master (note that
128not all BSPs are present in every release). Instead of extracting a
129BSP tarball at the top level of your yocto build tree, you can
130equivalently check out the appropriate branch from the meta-intel
131repository at the same location.
132
133
134II. Booting the images in /binary
135=================================
136
137This BSP contains bootable live images, which can be used to directly
138boot Yocto off of a USB flash drive.
139
140You can deploy the hddimg image to a USB or SATA device. You will
141need to know the device name on your host as well as the device name on
142the target. Be careful with this step as using the wrong host device can
143result in overwriting data on your host machine.
144
145Under Linux, USB and SATA devices typically appears as /dev/sdb,
146/dev/sdc, etc. Watching your system messages as you connect the device
147will tell you exactly which device name is assigned to the device.
148On the Valley Island platform, assuming only one storage device is
149attached at boot, a USB or SATA device will be /dev/sda.
150
151After inserting the boot media into your host machine and determining
152your host and target device, create the image using the mkefidisk.sh
153script, provided by poky under scripts/contrib/. Note that root
154privileges are required. For example, using an USB device which appears
155as /dev/sdc on the host:
156
157$ sudo ./mkefidisk.sh /dev/sdc core-image-sato-<machine>.hddimg /dev/sda
158
159Follow the prompts on the screen to confirm the action.
160
161This should give you a bootable USB flash device. Insert the device
162into a bootable USB socket on the target, and power on. This should
163result in a system booted to the Sato graphical desktop.
164
165If you want a terminal, use the arrows at the top of the UI to move to
166different pages of available applications, one of which is named
167'Terminal'. Clicking that should give you a root terminal.
168
169If you want to ssh into the system, you can use the root terminal to
170ifconfig the IP address and use that to ssh in. The root password is
171empty, so to log in type 'root' for the user name and hit 'Enter' at
172the Password prompt: and you should be in.
173
174III. Device Notes
175=================
176
177a. Boot Loader
178--------------
179- Support BIOS version at Shumway board (HighlandForest/CrystalForest-server):
180 CCFRCLC0.019
181
182- Support BIOS version at Stargo board ( CrystalForest-Gladden ):
183 CIVGCCK1.86C.0003.P00
184
185- Support BIOS version at Long Brook board (RiverForest)
186 GRNDCRB1.86B.0022.R01.i02.1405151000
187
188b. I/O drivers
189--------------
190-Support Matrox graphic card.
191-Support SATA, USB Host v2.0
192-Supported I/O devices (APIC, RTC, SPI, UART, I2C, LPS, SMBus i801,
193 WDT, and HPET)
194
195
196IV. Enabling Intel DPDK and QuickAssist Technology
197===================================================
198
199DPDK recipe: meta-intel/meta-isg/common/recipes-extended/dpdk
200QAT recipe: meta-intel/meta-isg/common/recipes-extended/qat
201QAT-enable zlib recipe: meta-intel/meta-isg/common/recipes-extended/zlib-qat
202
203Note:
204qat16 recipe is meant for platform with Coleto Creek chipset.
205qat15 recipe is meant for platform with Cave Creek chipset.
206
207conf/machine/crystalforest.conf is the common machine configuration
208to support Crystal Forest/server, Crystal Forest/gladden, Highland Forest and
209River Forest. In order to generate the right binary for these platforms which
210have different QAT technology, user could change the default config accordingly
211within crystalforest.conf as below:
212
213For Coleto Creek chipset:
214PREFERRED_PROVIDER_virtual/qat ?= "qat16"
215
216For Cave Creek chipset:
217PREFERRED_PROVIDER_virtual/qat ?= "qat15"
218
219Another option and preferred approach for above setting is to override
220configuration under build/conf/local.conf as follow:
221
222For Coleto Creek chipset:
223PREFERRED_PROVIDER_virtual/qat = "qat16"
224
225For Cave Creek chipset:
226PREFERRED_PROVIDER_virtual/qat = "qat15"
227
228By default, the machine configuration does not assume that the above
229ingredients are pre-installed onto the BSP. Developers are required
230to either use smart tool to install those software packages or
231configure IMAGE_INSTALL under build/conf/local.conf, for example.
232
233For Coleto Creek chipset:
234IMAGE_INSTALL += "dpdk qat16 zlib-qat"
235
236For Cavecreek Creek chipset:
237IMAGE_INSTALL += "dpdk qat15 zlib-qat"
238
239The list of packages can be searched under tmp/deploy/<package-type>
240folder.