mirror of
https://github.com/ARM-software/workload-automation.git
synced 2025-01-18 20:11:20 +00:00
Adding missing descriptions for modules.
This commit is contained in:
parent
aef7f52f96
commit
704324ca77
@ -21,6 +21,7 @@ from wlauto.utils.serial_port import open_serial_connection
|
||||
class MbedFanActiveCooling(Module):
|
||||
|
||||
name = 'mbed-fan'
|
||||
description = 'Controls a cooling fan via an mbed connected to a serial port.'
|
||||
|
||||
capabilities = ['active_cooling']
|
||||
|
||||
@ -52,6 +53,14 @@ class MbedFanActiveCooling(Module):
|
||||
class OdroidXU3ctiveCooling(Module):
|
||||
|
||||
name = 'odroidxu3-fan'
|
||||
description = """
|
||||
Enabled active cooling by controling the fan an Odroid XU3
|
||||
|
||||
.. note:: depending on the kernel used, it may not be possible to turn the fan
|
||||
off completely; in such situations, the fan will be set to its minimum
|
||||
speed.
|
||||
|
||||
"""
|
||||
|
||||
capabilities = ['active_cooling']
|
||||
|
||||
|
@ -59,6 +59,7 @@ class FastbootFlasher(Flasher):
|
||||
name = 'fastboot'
|
||||
description = """
|
||||
Enables automated flashing of images using the fastboot utility.
|
||||
|
||||
To use this flasher, a set of image files to be flused are required.
|
||||
In addition a mapping between partitions and image file is required. There are two ways
|
||||
to specify those requirements:
|
||||
@ -138,6 +139,20 @@ class FastbootFlasher(Flasher):
|
||||
class VersatileExpressFlasher(Flasher):
|
||||
|
||||
name = 'vexpress'
|
||||
description = """
|
||||
Enables flashing of kernels and firmware to ARM Versatile Express devices.
|
||||
|
||||
This modules enables flashing of image bundles or individual images to ARM
|
||||
Versatile Express-based devices (e.g. JUNO) via host-mounted MicroSD on the
|
||||
board.
|
||||
|
||||
The bundle, if specified, must reflect the directory structure of the MicroSD
|
||||
and will be extracted directly into the location it is mounted on the host. The
|
||||
images, if specified, must be a dict mapping the absolute path of the image on
|
||||
the host to the destination path within the board's MicroSD; the destination path
|
||||
may be either absolute, or relative to the MicroSD mount location.
|
||||
|
||||
"""
|
||||
|
||||
def flash(self, image_bundle=None, images=None):
|
||||
device = self.owner
|
||||
|
@ -24,6 +24,9 @@ class NetioSwitchReset(Module):
|
||||
|
||||
#pylint: disable=E1101
|
||||
name = 'netio_switch'
|
||||
description = """
|
||||
Enables hard reset of devices connected to a Netio ethernet power switch
|
||||
"""
|
||||
capabilities = ['reset_power']
|
||||
|
||||
parameters = [
|
||||
|
Loading…
x
Reference in New Issue
Block a user