plankton_display
================
**Source code:** `plankton_display.py <https://chromium.googlesource.com/chromiumos/platform/factory/+/refs/heads/main/py/test/pytests/plankton_display.py>`_

Tests USB type-C DP function with Plankton.

Description
-----------

See `here <https://chromium.googlesource.com/website/+/HEAD/site/chromium-os/plankton/index.md>`_ for Plankton introduction.

1. There is a fixture called Plankton-Raiden, which links/unlinks the DUT
   USB Type-C port.
2. There is another fixture called Plankton-HDMI, which is a DP sink and it
   can capture the DP output and verify it.

This test uses these fixtures to test USB type-C DP function.

Internal references
^^^^^^^^^^^^^^^^^^^

1. http://go/plankton_v3
2. http://go/cros-plankton-hdmi-introduction

Test Procedure
--------------
This is an automatic test that doesn't need any user interaction.

Dependency
----------
- bft_fixture
- Plankton

Examples
--------

No example is found.



Test Arguments
--------------
.. list-table::
   :widths: 20 10 60
   :header-rows: 1
   :align: left

   * - Name
     - Type
     - Description

   * - bft_fixture
     - dict
     - A dictionary with the following items:
       
         ``class_name``
           Fully-qualified class name of the BFTFixture implementation
           to use.
       
         ``params``
           A dictionary of parameters for the BFTFixture class's ``Init()``
           method.
       
       The default value of ``None`` means that no BFT fixture is used.

   * - usb_c_index
     - int
     - Index of DUT USB type-C port

   * - bft_media_device
     - str
     - Device name of BFT used to insert/remove the media.

   * - display_id
     - str
     - Display ID used to identify display in xrandr/modeprint.

   * - capture_resolution
     - list
     - (optional; default: ``[1920, 1080]``) [x-res, y-res] indicating the image capture resolution to use.

   * - capture_fps
     - int
     - (optional; default: ``30``) Camera capture rate in frames per second.

   * - uvc_video_dev_index
     - int
     - (optional; default: ``-1``) index of video device (-1 for default)

   * - uvc_video_dev_port
     - str, None
     - (optional; default: ``None``) port of video device (ex. 3-1)

   * - corr_value_threshold
     - list
     - (optional; default: ``[0.8, 0.8, 0.8]``) [b, g, r] channel histogram correlation pass/fail threshold. Should be int/float type, ex. [0.8, 0.8, 0.8]

   * - dp_verify_server
     - str, None
     - (optional; default: ``None``) Server URL for verifying DP output, e.g. "http://192.168.0.1:9999". Default None means verifying locally.

   * - verify_display_switch
     - bool
     - (optional; default: ``True``) Set False to test without display switch, and compare default wallpaper only (can save more testing time).

   * - force_dp_renegotiated
     - bool
     - (optional; default: ``False``) Force DP to renegotiate with plankton by disconnecting TypeC port

   * - fire_hpd_manually
     - bool
     - (optional; default: ``False``) Fire HPD manually.