diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-02-22 16:13:29 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-03-08 12:08:02 -0800 |
commit | e856eed4e3539cce803425ec7b0edfdc1265e3fa (patch) | |
tree | f0202de637fb13cf50fd32b6ba9a961f75de9e0c | |
parent | d035bb875f81a501e265e278ec0c552fe0cd4e3b (diff) | |
download | poky-e856eed4e3539cce803425ec7b0edfdc1265e3fa.tar.gz |
documentation/bsp-guide/bsp.xml: Edits to HW Configuration Options Section
Made some minor edits. I also discovered that the information
describing where tuning files reside was not real helpful.
In particular, tuning files are not limited to the
meta/conf/machine/include directory. For example, the Crown Bay
BSP layer includes a tuning file from the meta-intel Layer.
(From yocto-docs rev: 3a76ccc4f645f03a6e888b7eb53fa9bc7bfb255e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/bsp-guide/bsp.xml | 23 |
1 files changed, 16 insertions, 7 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index a957409ec8..019a78f0a0 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml | |||
@@ -355,19 +355,20 @@ | |||
355 | If the BSP supports multiple machines, multiple machine configuration files | 355 | If the BSP supports multiple machines, multiple machine configuration files |
356 | can be present. | 356 | can be present. |
357 | These filenames correspond to the values to which users have set the | 357 | These filenames correspond to the values to which users have set the |
358 | <filename>MACHINE</filename> variable. | 358 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE'><filename>MACHINE</filename></ulink> variable. |
359 | </para> | 359 | </para> |
360 | 360 | ||
361 | <para> | 361 | <para> |
362 | These files define things such as the kernel package to use | 362 | These files define things such as the kernel package to use |
363 | (<filename>PREFERRED_PROVIDER</filename> of virtual/kernel), the hardware drivers to | 363 | (<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PREFERRED_PROVIDER'><filename>PREFERRED_PROVIDER</filename></ulink> |
364 | of virtual/kernel), the hardware drivers to | ||
364 | include in different types of images, any special software components | 365 | include in different types of images, any special software components |
365 | that are needed, any bootloader information, and also any special image | 366 | that are needed, any bootloader information, and also any special image |
366 | format requirements. | 367 | format requirements. |
367 | </para> | 368 | </para> |
368 | 369 | ||
369 | <para> | 370 | <para> |
370 | At least one machine file is required for a BSP layer. | 371 | Each BSP Layer requires at least one machine file. |
371 | However, you can supply more than one file. | 372 | However, you can supply more than one file. |
372 | For example, in the Crown Bay BSP shown earlier in this section, the | 373 | For example, in the Crown Bay BSP shown earlier in this section, the |
373 | <filename>conf/machine</filename> directory contains two configuration files: | 374 | <filename>conf/machine</filename> directory contains two configuration files: |
@@ -383,19 +384,27 @@ | |||
383 | <para> | 384 | <para> |
384 | This <filename>crownbay.conf</filename> file could also include | 385 | This <filename>crownbay.conf</filename> file could also include |
385 | a hardware "tuning" file that is commonly used to | 386 | a hardware "tuning" file that is commonly used to |
386 | define the the package architecture and specify | 387 | define the package architecture and specify |
387 | optimization flags, which are carefully chosen to give best | 388 | optimization flags, which are carefully chosen to give best |
388 | performance on a given processor. | 389 | performance on a given processor. |
389 | </para> | 390 | </para> |
390 | 391 | ||
391 | <para> | 392 | <para> |
392 | Tuning files are found in the <filename>meta/conf/machine/include</filename> | 393 | Tuning files are found in the <filename>meta/conf/machine/include</filename> |
393 | directory. | 394 | directory of the |
394 | To use them, you simply include them in the machine configuration file. | 395 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-files'>Yocto Project Files</ulink>. |
396 | Tuning files can also reside in the BSP Layer itself. | ||
397 | For example, the <filename>ia32-base.inc</filename> file resides in the | ||
398 | <filename>meta-intel</filename> BSP Layer in <filename>conf/machine/include</filename>. | ||
399 | </para> | ||
400 | |||
401 | <para> | ||
402 | To use an include file, you simply include them in the machine configuration file. | ||
395 | For example, the Crown Bay BSP <filename>crownbay.conf</filename> has the | 403 | For example, the Crown Bay BSP <filename>crownbay.conf</filename> has the |
396 | following statement: | 404 | following statements: |
397 | <literallayout class='monospaced'> | 405 | <literallayout class='monospaced'> |
398 | include conf/machine/include/tune-atom.inc | 406 | include conf/machine/include/tune-atom.inc |
407 | include conf/machine/include/ia32-base.inc | ||
399 | </literallayout> | 408 | </literallayout> |
400 | </para> | 409 | </para> |
401 | </section> | 410 | </section> |