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