Blame - documentation/bsp-guide/bsp.xml - stefanberger/openbmc

"<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</ulink>"

1236

section in the Yocto Project Development Guide.

1237

</note>

</para>

<para>

The next sections provide a concrete starting point to expand on a few points that

1242

might not be immediately obvious or that could use further explanation.

</para>

</section>

<title>Creating a new BSP Layer Using the yocto-bsp Script</title>

1249

1250

<para>

1251

The <filename>yocto-bsp</filename> script creates a new

1252

1253

by the Yocto Project, as well as QEMU versions of the same.

1254

The default mode of the script's operation is to prompt you for information needed

1255

to generate the BSP layer.

</para>

<para>

For the current set of BSPs, the script prompts you for various important

1260

parameters such as:

1261

1262

<listitem><para>The kernel to use</para></listitem>

1263

<listitem><para>The branch of that kernel to use (or re-use)</para></listitem>

1264

<listitem><para>Whether or not to use X, and if so, which drivers to use</para></listitem>

1265

<listitem><para>Whether to turn on SMP</para></listitem>

1266

<listitem><para>Whether the BSP has a keyboard</para></listitem>

1267

<listitem><para>Whether the BSP has a touchscreen</para></listitem>

1268

<listitem><para>Remaining configurable items associated with the BSP</para></listitem>

</itemizedlist>

</para>

<para>

You use the <filename>yocto-bsp create</filename> sub-command to create

1274

a new BSP layer.

1275

This command requires you to specify a particular kernel architecture

1276

(<filename>karch</filename>) on which to base the BSP.

1277

Assuming you have sourced the environment, you can use the

1278

<filename>yocto-bsp list karch</filename> sub-command to list the

1279

architectures available for BSP creation as follows:

1280

1281

$ yocto-bsp list karch

1282

Architectures available:

qemu

mips64

powerpc

x86_64

arm

mips

i386

</literallayout>

</para>

<para>

The remainder of this section presents an example that uses

1295

<filename>myarm</filename> as the machine name and <filename>qemu</filename>

1296

as the machine architecture.

1297

Of the available architectures, <filename>qemu</filename> is the only architecture

1298

that causes the script to prompt you further for an actual architecture.

1299

In every other way, this architecture is representative of how creating a BSP for

1300

an actual machine would work.

1301

The reason the example uses this architecture is because it is an emulated architecture

1302

and can easily be followed without requiring actual hardware.

</para>

<para>

As the <filename>yocto-bsp create</filename> command runs, default values for

1307

the prompts appear in brackets.

1308

Pressing enter without supplying anything on the command line or pressing enter

1309

with an invalid response causes the script to accept the default value.

1310

Once the script completes, the new <filename>meta-myarm</filename> BSP layer

1311

is created in the current working directory.

1312

This example assumes you have sourced the

setup script.

</para>

<para>

Following is the complete example:

1319

1320

$ yocto-bsp create myarm qemu

1321

Checking basic git connectivity...

1322

Done.

1323

Which qemu architecture would you like to use? [default: i386]

1) i386 (32-bit)

2) x86_64 (64-bit)

3) ARM (32-bit)

4) PowerPC (32-bit)

5) MIPS (32-bit)

6) MIPS64 (64-bit)

3

Would you like to use the default (3.19) kernel? (y/n) [default: y] y

1332

Do you need a new machine branch for this BSP (the alternative is to re-use an existing branch)? [y/n] [default: y]

1333

Getting branches from remote repo git://git.yoctoproject.org/linux-yocto-3.19.git...

1334

Please choose a machine branch to base your new BSP branch on: [default: standard/base]

1335

1) standard/arm-versatile-926ejs

1336

2) standard/base

1337

3) standard/beagleboard

1338

4) standard/beaglebone

1339

5) standard/ck

1340

6) standard/common-pc

1341

7) standard/crownbay

1342

8) standard/edgerouter

1343

9) standard/fsl-mpc8315e-rdb

1344

10) standard/mti-malta32

1345

11) standard/mti-malta64

1346

12) standard/qemuarm64

1347

13) standard/qemuppc

1348

1

1349

Would you like SMP support? (y/n) [default: y]

1350

Does your BSP have a touchscreen? (y/n) [default: n]

1351

Does your BSP have a keyboard? (y/n) [default: y]

1352

New qemu BSP created in meta-myarm

1353

</literallayout>

1354

Take a closer look at the example now:

1355

1356

<listitem><para>For the QEMU architecture,

1357

the script first prompts you for which emulated architecture to use.

1358

In the example, we use the ARM architecture.

1359

</para></listitem>

1360

<listitem><para>The script then prompts you for the kernel.

1361

The default 3.19 kernel is acceptable.

1362

So, the example accepts the default.

1363

If you enter 'n', the script prompts you to further enter the kernel

1364

you do want to use.</para></listitem>

1365

<listitem><para>Next, the script asks whether you would like to have a new

1366

branch created especially for your BSP in the local

1367

<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Linux Yocto Kernel</ulink>

1368

Git repository .

1369

If not, then the script re-uses an existing branch.</para>

1370

<para>In this example, the default (or "yes") is accepted.

1371

Thus, a new branch is created for the BSP rather than using a common, shared

1372

branch.

1373

The new branch is the branch committed to for any patches you might later add.

1374

The reason a new branch is the default is that typically

1375

new BSPs do require BSP-specific patches.

1376

The tool thus assumes that most of time a new branch is required.

1377

</para></listitem>

1378

<listitem><para>Regardless of which choice you make in the previous step,

1379

you are now given the opportunity to select a particular machine branch on

1380

which to base your new BSP-specific machine branch

1381

(or to re-use if you had elected to not create a new branch).

1382

Because this example is generating an ARM-based BSP, the example

1383

uses <filename>#1</filename> at the prompt, which selects the ARM-versatile branch.

1384

</para></listitem>

1385

<listitem><para>The remainder of the prompts are routine.

1386

Defaults are accepted for each.</para></listitem>

1387

<listitem><para>By default, the script creates the new BSP Layer in the

1388

current working directory of the

1389

<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,

1390

(i.e. <filename>poky/build</filename>).

</para></listitem>

</orderedlist>

</para>

<para>

Once the BSP Layer is created, you must add it to your

1397

<filename>bblayers.conf</filename> file.

Here is an example:

BBLAYERS = ? " \

/usr/local/src/yocto/meta \

1402

/usr/local/src/yocto/meta-yocto \

1403

/usr/local/src/yocto/meta-yocto-bsp \

1404

/usr/local/src/yocto/meta-myarm \

1405

"

1406

1407

BBLAYERS_NON_REMOVABLE ?= " \

1408

/usr/local/src/yocto/meta \

1409

/usr/local/src/yocto/meta-yocto \

1410

"

1411

</literallayout>

1412

Adding the layer to this file allows the build system to build the BSP and

1413

the <filename>yocto-kernel</filename> tool to be able to find the layer and

1414

other Metadata it needs on which to operate.

</para>

</section>

<title>Managing Kernel Patches and Config Items with yocto-kernel</title>

1420

1421

<para>

1422

Assuming you have created a <link linkend='bsp-layers'>BSP Layer</link> using

1423

1424

<filename>yocto-bsp</filename></link> and you added it to your

1425

<ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink>

1426

variable in the <filename>bblayers.conf</filename> file, you can now use

1427

the <filename>yocto-kernel</filename> script to add patches and configuration

1428

items to the BSP's kernel.

</para>

<para>

The <filename>yocto-kernel</filename> script allows you to add, remove, and list patches

1433

and kernel config settings to a BSP's kernel

1434

<filename>.bbappend</filename> file.

1435

All you need to do is use the appropriate sub-command.

1436

Recall that the easiest way to see exactly what sub-commands are available

1437

is to use the <filename>yocto-kernel</filename> built-in help as follows:

1438

1439

$ yocto-kernel --help

1440

Usage:

1441

Modify and list Yocto BSP kernel config items and patches.

1442

usage: yocto-kernel [--version] [--help] COMMAND [ARGS]

1443

Current 'yocto-kernel' commands are:

1444

config list List the modifiable set of bare kernel config options for a BSP

1445

config add Add or modify bare kernel config options for a BSP

1446

config rm Remove bare kernel config options from a BSP

1447

patch list List the patches associated with a BSP

1448

patch add Patch the Yocto kernel for a BSP

1449

patch rm Remove patches from a BSP

1450

feature list List the features used by a BSP

1451

feature add Have a BSP use a feature

1452

feature rm Have a BSP stop using a feature

1453

features list List the features available to BSPs

1454

feature describe Describe a particular feature

1455

feature create Create a new BSP-local feature

1456

feature destroy Remove a BSP-local feature

1457

See 'yocto-kernel help COMMAND' for more information on a specific command.

1458

Options:

1459

--version show program's version number and exit

1460

-h, --help show this help message and exit

1461

-D, --debug output debug information

</literallayout>

</para>

<para>

The <filename>yocto-kernel patch add</filename> sub-command allows you to add a

1467

patch to a BSP.

1468

The following example adds two patches to the <filename>myarm</filename> BSP:

1469

1470

$ yocto-kernel patch add myarm ~/test.patch

Added patches:

test.patch

$ yocto-kernel patch add myarm ~/yocto-testmod.patch

Added patches:

yocto-testmod.patch

</literallayout>

<note>Although the previous example adds patches one at a time, it is possible

1479

to add multiple patches at the same time.</note>

</para>

<para>

You can verify patches have been added by using the

1484

<filename>yocto-kernel patch list</filename> sub-command.

1485

Here is an example:

1486

1487

$ yocto-kernel patch list myarm

1488

The current set of machine-specific patches for myarm is:

1489

1) test.patch

1490

2) yocto-testmod.patch

</literallayout>

</para>

<para>

You can also use the <filename>yocto-kernel</filename> script to

1496

remove a patch using the <filename>yocto-kernel patch rm</filename> sub-command.

1497

Here is an example:

1498

1499

$ yocto-kernel patch rm myarm

1500

Specify the patches to remove:

1501

1) test.patch

1502

2) yocto-testmod.patch

1

Removed patches:

test.patch

</literallayout>

</para>

<para>

Again, using the <filename>yocto-kernel patch list</filename> sub-command,

1511

you can verify that the patch was in fact removed:

1512

1513

$ yocto-kernel patch list myarm

1514

The current set of machine-specific patches for myarm is:

1515

1) yocto-testmod.patch

</literallayout>

</para>

<para>

In a completely similar way, you can use the <filename>yocto-kernel config add</filename>

1521

sub-command to add one or more kernel config item settings to a BSP.

1522

The following commands add a couple of config items to the

1523

<filename>myarm</filename> BSP:

1524

1525

$ yocto-kernel config add myarm CONFIG_MISC_DEVICES=y

1526

Added item:

1527

CONFIG_MISC_DEVICES=y

1528

1529

$ yocto-kernel config add myarm CONFIG_YOCTO_TESTMOD=y

1530

Added item:

1531

CONFIG_YOCTO_TESTMOD=y

1532

</literallayout>

1533

<note>

1534

Although the previous example adds config items one at a time, it is possible

1535

to add multiple config items at the same time.

</note>

</para>

<para>

You can list the config items now associated with the BSP.

1541

Doing so shows you the config items you added as well as others associated

1542

with the BSP:

1543

1544

$ yocto-kernel config list myarm

1545

The current set of machine-specific kernel config items for myarm is:

1546

1) CONFIG_MISC_DEVICES=y

1547

2) CONFIG_YOCTO_TESTMOD=y

</literallayout>

</para>

<para>

Finally, you can remove one or more config items using the

1553

<filename>yocto-kernel config rm</filename> sub-command in a manner

1554

completely analogous to <filename>yocto-kernel patch rm</filename>.

</para>

</section>

</section>

</chapter>