| Sergei Trofimov | 1ba7fbd | 2016-12-09 15:06:35 +0000 | [diff] [blame] | 1 | .. _platform: |
| 2 | |
| 3 | Platform |
| 4 | ======== |
| 5 | |
| 6 | :class:`Platform`\ s describe the system underlying the OS. They encapsulate |
| 7 | hardware- and firmware-specific details. In most cases, the generic |
| 8 | :class:`Platform` class, which gets used if a platform is not explicitly |
| 9 | specified on :class:`Target` creation, will be sufficient. It will automatically |
| 10 | query as much platform information (such CPU topology, hardware model, etc) if |
| 11 | it was not specified explicitly by the user. |
| 12 | |
| 13 | |
| 14 | .. class:: Platform(name=None, core_names=None, core_clusters=None,\ |
| 15 | big_core=None, model=None, modules=None) |
| 16 | |
| 17 | :param name: A user-friendly identifier for the platform. |
| 18 | :param core_names: A list of CPU core names in the order they appear |
| 19 | registered with the OS. If they are not specified, |
| 20 | they will be queried at run time. |
| 21 | :param core_clusters: Alist with cluster ids of each core (starting with |
| 22 | 0). If this is not specified, clusters will be |
| 23 | inferred from core names (cores with the same name are |
| 24 | assumed to be in a cluster). |
| 25 | :param big_core: The name of the big core in a big.LITTLE system. If this is |
| 26 | not specified it will be inferred (on systems with exactly |
| 27 | two clasters). |
| 28 | :param model: Model name of the hardware system. If this is not specified it |
| 29 | will be queried at run time. |
| 30 | :param modules: Modules with additional functionality supported by the |
| 31 | platfrom (e.g. for handling flashing, rebooting, etc). These |
| 32 | would be added to the Target's modules. (See :ref:`modules`\ ). |
| 33 | |
| 34 | |
| 35 | Versatile Express |
| 36 | ----------------- |
| 37 | |
| 38 | The generic platform may be extended to support hardware- or |
| 39 | infrastructure-specific functionality. Platforms exist for ARM |
| 40 | VersatileExpress-based :class:`Juno` and :class:`TC2` development boards. In |
| 41 | addition to the standard :class:`Platform` parameters above, these platfroms |
| 42 | support additional configuration: |
| 43 | |
| 44 | |
| 45 | .. class:: VersatileExpressPlatform |
| 46 | |
| 47 | Normally, this would be instatiated via one of its derived classes |
| 48 | (:class:`Juno` or :class:`TC2`) that set appropriate defaults for some of |
| 49 | the parameters. |
| 50 | |
| 51 | :param serial_port: Identifies the serial port (usual a /dev node) on which the |
| 52 | device is connected. |
| 53 | :param baudrate: Baud rate for the serial connection. This defaults to |
| 54 | ``115200`` for :class:`Juno` and ``38400`` for |
| 55 | :class:`TC2`. |
| 56 | :param vemsd_mount: Mount point for the VEMSD (Versatile Express MicroSD card |
| 57 | that is used for board configuration files and firmware |
| 58 | images). This defaults to ``"/media/JUNO"`` for |
| 59 | :class:`Juno` and ``"/media/VEMSD"`` for :class:`TC2`, |
| 60 | though you would most likely need to change this for |
| 61 | your setup as it would depend both on the file system |
| 62 | label on the MicroSD card, and on how the card was |
| 63 | mounted on the host system. |
| 64 | :param hard_reset_method: Specifies the method for hard-resetting the devices |
| 65 | (e.g. if it becomes unresponsive and normal reboot |
| 66 | method doesn not work). Currently supported methods |
| 67 | are: |
| 68 | |
| 69 | :dtr: reboot by toggling DTR line on the serial |
| 70 | connection (this is enabled via a DIP switch |
| 71 | on the board). |
| 72 | :reboottxt: reboot by writing a filed called |
| 73 | ``reboot.txt`` to the root of the VEMSD |
| 74 | mount (this is enabled via board |
| 75 | configuration file). |
| 76 | |
| 77 | This defaults to ``dtr`` for :class:`Juno` and |
| 78 | ``reboottxt`` for :class:`TC2`. |
| 79 | :param bootloader: Specifies the bootloader configuration used by the board. |
| 80 | The following values are currently supported: |
| 81 | |
| 82 | :uefi: Boot via UEFI menu, by selecting the entry |
| 83 | specified by ``uefi_entry`` paramter. If this |
| 84 | entry does not exist, it will be automatically |
| 85 | created based on values provided for ``image``, |
| 86 | ``initrd``, ``fdt``, and ``bootargs`` parameters. |
| 87 | :uefi-shell: Boot by going via the UEFI shell. |
| 88 | :u-boot: Boot using Das U-Boot. |
| 89 | :bootmon: Boot directly via Versatile Express Bootmon |
| 90 | using the values provided for ``image``, |
| 91 | ``initrd``, ``fdt``, and ``bootargs`` |
| 92 | parameters. |
| 93 | |
| 94 | This defaults to ``u-boot`` for :class:`Juno` and |
| 95 | ``bootmon`` for :class:`TC2`. |
| 96 | :param flash_method: Specifies how the device is flashed. Currently, only |
| 97 | ``"vemsd"`` method is supported, which flashes by |
| 98 | writing firmware images to an appropriate location on |
| 99 | the VEMSD. |
| 100 | :param image: Specfies the kernel image name for ``uefi`` or ``bootmon`` boot. |
| 101 | :param fdt: Specifies the device tree blob for ``uefi`` or ``bootmon`` boot. |
| 102 | :param initrd: Specifies the ramdisk image for ``uefi`` or ``bootmon`` boot. |
| 103 | :param bootargs: Specifies the boot arguments that will be pass to the |
| 104 | kernel by the bootloader. |
| 105 | :param uefi_entry: Then name of the UEFI entry to be used/created by |
| 106 | ``uefi`` bootloader. |
| 107 | :param ready_timeout: Timeout, in seconds, for the time it takes the |
| 108 | platform to become ready to accept connections. Note: |
| 109 | this does not mean that the system is fully booted; |
| 110 | just that the services needed to establish a |
| 111 | connection (e.g. sshd or adbd) are up. |
| 112 | |