diff options
Diffstat (limited to 'documentation/dev-manual')
| -rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 107 |
1 files changed, 103 insertions, 4 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 9565b1b950..0123d84e69 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
| @@ -7742,8 +7742,7 @@ Gateways via their Web Interfaces</ulink>"</emphasis> | |||
| 7742 | <filename>TEST_TARGET</filename> to an appropriate value. | 7742 | <filename>TEST_TARGET</filename> to an appropriate value. |
| 7743 | For QEMU, you do not have to change anything, the default | 7743 | For QEMU, you do not have to change anything, the default |
| 7744 | value is "QemuTarget". | 7744 | value is "QemuTarget". |
| 7745 | For running tests on hardware, two options exist: | 7745 | For running tests on hardware, the following options exist: |
| 7746 | "SimpleRemoteTarget" and "GummibootTarget". | ||
| 7747 | <itemizedlist> | 7746 | <itemizedlist> |
| 7748 | <listitem><para><emphasis>"SimpleRemoteTarget":</emphasis> | 7747 | <listitem><para><emphasis>"SimpleRemoteTarget":</emphasis> |
| 7749 | Choose "SimpleRemoteTarget" if you are going to | 7748 | Choose "SimpleRemoteTarget" if you are going to |
| @@ -7770,6 +7769,45 @@ Gateways via their Web Interfaces</ulink>"</emphasis> | |||
| 7770 | "<link linkend='selecting-gummiboottarget'>Selecting GummibootTarget</link>" | 7769 | "<link linkend='selecting-gummiboottarget'>Selecting GummibootTarget</link>" |
| 7771 | section, which follows, for more information. | 7770 | section, which follows, for more information. |
| 7772 | </para></listitem> | 7771 | </para></listitem> |
| 7772 | <listitem><para><emphasis>"BeagleBoneTarget":</emphasis> | ||
| 7773 | Choose "BeagleBoneTarget" if you are deploying | ||
| 7774 | images and running tests on the BeagleBone | ||
| 7775 | "Black" or original "White" hardware. | ||
| 7776 | For information on how to use these tests, see the | ||
| 7777 | comments at the top of the BeagleBoneTarget | ||
| 7778 | <filename>meta-yocto-bsp/lib/oeqa/controllers/beaglebonetarget.py</filename> | ||
| 7779 | file. | ||
| 7780 | </para></listitem> | ||
| 7781 | <listitem><para><emphasis>"EdgeRouterTarget":</emphasis> | ||
| 7782 | Choose "EdgeRouterTarget" is you are deploying | ||
| 7783 | images and running tests on the Ubiquiti Networks | ||
| 7784 | EdgeRouter Lite. | ||
| 7785 | For information on how to use these tests, see the | ||
| 7786 | comments at the top of the EdgeRouterTarget | ||
| 7787 | <filename>meta-yocto-bsp/lib/oeqa/controllers/edgeroutertarget.py</filename> | ||
| 7788 | file. | ||
| 7789 | </para></listitem> | ||
| 7790 | <listitem><para><emphasis>"GrubTarget":</emphasis> | ||
| 7791 | Choose the "supports deploying images and running | ||
| 7792 | tests on any generic PC that boots using GRUB. | ||
| 7793 | For information on how to use these tests, see the | ||
| 7794 | comments at the top of the GrubTarget | ||
| 7795 | <filename>meta-yocto-bsp/lib/oeqa/controllers/grubtarget.py</filename> | ||
| 7796 | file. | ||
| 7797 | </para></listitem> | ||
| 7798 | <listitem><para><emphasis>"<replaceable>your-target</replaceable>":</emphasis> | ||
| 7799 | Create your own custom target if you want to run | ||
| 7800 | tests when you are deploying images and running | ||
| 7801 | tests on a custom machine within your BSP layer. | ||
| 7802 | To do this, you need to add a Python unit that | ||
| 7803 | defines the target class under | ||
| 7804 | <filename>lib/oeqa/controllers/</filename> within | ||
| 7805 | your layer. | ||
| 7806 | You must also provide an empty | ||
| 7807 | <filename>__init__.py</filename>. | ||
| 7808 | For examples, see files in | ||
| 7809 | <filename>meta-yocto-bsp/lib/oeqa/controllers/</filename>. | ||
| 7810 | </para></listitem> | ||
| 7773 | </itemizedlist> | 7811 | </itemizedlist> |
| 7774 | </para> | 7812 | </para> |
| 7775 | </section> | 7813 | </section> |
| @@ -7880,10 +7918,14 @@ Gateways via their Web Interfaces</ulink>"</emphasis> | |||
| 7880 | </para></listitem> | 7918 | </para></listitem> |
| 7881 | </orderedlist> | 7919 | </orderedlist> |
| 7882 | </para> | 7920 | </para> |
| 7921 | </section> | ||
| 7922 | |||
| 7923 | <section id='power-control'> | ||
| 7924 | <title>Power Control</title> | ||
| 7883 | 7925 | ||
| 7884 | <para> | 7926 | <para> |
| 7885 | Here is some additional information regarding running | 7927 | For most hardware targets other than SimpleRemoteTarget, |
| 7886 | "GummibootTarget" as your test target: | 7928 | you can control power: |
| 7887 | <itemizedlist> | 7929 | <itemizedlist> |
| 7888 | <listitem><para> | 7930 | <listitem><para> |
| 7889 | You can use | 7931 | You can use |
| @@ -7928,6 +7970,63 @@ Gateways via their Web Interfaces</ulink>"</emphasis> | |||
| 7928 | some manual interaction is okay from time to time. | 7970 | some manual interaction is okay from time to time. |
| 7929 | </para></listitem> | 7971 | </para></listitem> |
| 7930 | </itemizedlist> | 7972 | </itemizedlist> |
| 7973 | If you have no hardware to automatically perform power | ||
| 7974 | control but still wish to experiment with automated | ||
| 7975 | hardware testing, you can use the dialog-power-control | ||
| 7976 | script that shows a dialog prompting you to perform the | ||
| 7977 | required power action. | ||
| 7978 | This script requires either KDialog or Zenity to be | ||
| 7979 | installed. | ||
| 7980 | To use this script, set the | ||
| 7981 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_POWERCONTROL_CMD'><filename>TEST_POWERCONTROL_CMD</filename></ulink> | ||
| 7982 | variable as follows: | ||
| 7983 | <literallayout class='monospaced'> | ||
| 7984 | TEST_POWERCONTROL_CMD = "${COREBASE}/scripts/contrib/dialog-power-control" | ||
| 7985 | </literallayout> | ||
| 7986 | </para> | ||
| 7987 | </section> | ||
| 7988 | |||
| 7989 | <section id='serial-console-connection'> | ||
| 7990 | <title>Serial Console Connection</title> | ||
| 7991 | |||
| 7992 | <para> | ||
| 7993 | For test target classes requiring a serial console | ||
| 7994 | to interact with the bootloader (e.g. BeagleBoneTarget, | ||
| 7995 | EdgeRouterTarget, and GrubTarget), you need to | ||
| 7996 | specify a command to use to connect to the serial console | ||
| 7997 | of the target machine by using the | ||
| 7998 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_POWERCONTROL_CMD'><filename>TEST_POWERCONTROL_CMD</filename></ulink> | ||
| 7999 | variable and optionally the | ||
| 8000 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_SERIALCONTROL_EXTRA_ARGS'><filename>TEST_SERIALCONTROL_EXTRA_ARGS</filename></ulink> | ||
| 8001 | variable. | ||
| 8002 | </para> | ||
| 8003 | |||
| 8004 | <para> | ||
| 8005 | These cases could be a serial terminal program if the | ||
| 8006 | machine is connected to a local serial port, or a | ||
| 8007 | <filename>telnet</filename> or | ||
| 8008 | <filename>ssh</filename> command connecting to a remote | ||
| 8009 | console server. | ||
| 8010 | Regardless of the case, the command simply needs to | ||
| 8011 | connect to the serial console and forward that connection | ||
| 8012 | to standard input and output as any normal terminal | ||
| 8013 | program does. | ||
| 8014 | For example, to use the picocom terminal program on | ||
| 8015 | serial device <filename>/dev/ttyUSB0</filename> | ||
| 8016 | at 115200bps, you would set the variable as follows: | ||
| 8017 | <literallayout class='monospaced'> | ||
| 8018 | TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200" | ||
| 8019 | </literallayout> | ||
| 8020 | For local devices where the serial port device disappears | ||
| 8021 | when the device reboots, an additional "serdevtry" wrapper | ||
| 8022 | script is provided. | ||
| 8023 | To use this wrapper, simply prefix the terminal command | ||
| 8024 | with | ||
| 8025 | <filename>${COREBASE}/scripts/contrib/serdevtry</filename>: | ||
| 8026 | <literallayout class='monospaced'> | ||
| 8027 | TEST_SERIALCONTROL_CMD = "${COREBASE}/scripts/contrib/serdevtry picocom -b | ||
| 8028 | 115200 /dev/ttyUSB0" | ||
| 8029 | </literallayout> | ||
| 7931 | </para> | 8030 | </para> |
| 7932 | </section> | 8031 | </section> |
| 7933 | </section> | 8032 | </section> |
