.. include:: ../substitutions.rst

.. _fan-64:

Fan
===

The phyCORE-AM64x development kit provides fan connectivity via a 4-pin Hirose connector at X12 (VCC_5V0_SW rail). The fan is intended to be mounted directly to the processor heat sink for thermal management. The regulated 5V output is enabled by driving GPIO0_28 low (0), turning the fan on. When GPIO0_28 is pulled high (1), the 5V supplied to the fan connector will be turned off. This guide will demonstrate how to test your connections to the header x12. To learn more information about the phyCORE-AM64x thermal management and fan utilization, please see section 4.9 in the `Hardware Manual <https://www.phytec.com/product/phycore-am64x/#section-hardware-documentation>`_.

.. image:: ../../images/phycore-am64x/pb-07225_fan.png
   :width: 800px
   :alt: phyCORE-AM64x Fan Location



Requirements
------------

The phyCORE-AM64x development kit does not include a heat sink and fan. The below is the fan tested on the PHYTEC hardware:

.. list-table::
   :header-rows: 1

   * - Item
     - Description
     - Link
   * - Heat Sink
     - (29mmx29mmx9.5mm)
     - `Digikey link (heat sink) <https://www.digikey.com/en/products/detail/advanced-thermal-solutions-inc/ATS-55290D-C1-R0/1284984>`_
   * - Fan
     - DC axial fan, 30mm square x 10mm
     - `Digikey link (fan) <https://www.digikey.com/en/products/detail/cui-devices/CFM-3010B-0130-373-22/16581921?utm_adgroup=DC%20Fans&utm_source=google&utm_medium=cpc&utm_campaign=Shopping_Product_Fans%2C%20Thermal%20Management&utm_term=&utm_content=DC%20Fans&gclid=EAIaIQobChMIluH6iIfU-wIVEXxvBB08VAGPEAQYASABEgKKBfD_BwE>`_
   * - Female Connector
     - 4 pin keyed header
     - `Digikey link (female connector) <https://www.digikey.com/en/products/detail/hirose-electric-co-ltd/DF13-4S-1-25C/241750?utm_adgroup=Connectors%20%26%20Interconnects&utm_source=google&utm_medium=cpc&utm_campaign=Dynamic%20Search_EN_RLSA&utm_term=&utm_content=Connectors%20%26%20Interconnects&gclid=EAIaIQobChMI57GD-6zU-wIV8G5vBB3k4A0ZEAAYAiAAEgLHL_D_BwE>`_
   * - Crimping Terminals
     - 4x crimping jackets
     - `Mouser link <https://www.mouser.com/ProductDetail/Hirose-Connector/DF13-2630SCF?qs=Ux3WWAnHpjA5SO9UIiadCA%3D%3D>`_


.. image:: ../../images/phycore-am64x/pb-07225_x12-schematic-1566-1.png
   :width: 700px
   :alt: phyCORE-AM64x (1566.1) Fan Schematic


Recommended Header Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. list-table::
   :header-rows: 1

   * - Pin
     - Signal
     - Wire Color
   * - 1
     - VCC_5V0_SW
     - Red
   * - 2
     - GND
     - Black
   * - 3
     - FAN_FG
     - Yellow
   * - 4
     - PWM
     - Blue


Connecting Your Fan
--------------------

* Connect fan to the 4-pin Hirose connector located at X12.

  .. image:: ../../images/phycore-am64x/pb-07225_fan_pin1.png
   :width: 600px
   :alt: phyCORE-AM64x Fan Pin 1 Location


Enabling the Overlay
---------------------
* Power on the development kit and stop in U-boot.

* Load the device tree overlay required for exporting the GPIO signal that controls the fan and then boot the board.

  .. code-block:: none
    :caption: Target (U-boot)

    setenv overlays k3-am64-phyboard-electra-gpio-fan.dtbo
    boot

.. note::
   For more information about overlays see chapter :ref:`ConfiguringTheBootloader-64`.

* Verify that the "gpio-fan" was exported properly to gpio-453.

  .. code-block:: none
   :caption: Target (Linux)

   cat /sys/kernel/debug/gpio

  .. code-block:: none
    :caption: Expected Output

     root@phyboard-electra-am64xx-2:~# cat /sys/kernel/debug/gpio
     gpiochip1: GPIOs 337-424, parent: platform/601000.gpio, 601000.gpio:
     gpio-355 (                    |PHY reset           ) out lo ACTIVE LOW
     gpio-356 (                    |PHY reset           ) out lo ACTIVE LOW
     gpio-379 (                    |wp                  ) out lo
     gpio-380 (                    |spi1 CS1            ) out lo ACTIVE LOW

     gpiochip0: GPIOs 425-511, parent: platform/600000.gpio, 600000.gpio:
     gpio-437 (                    |green:heartbeat     ) out lo
     gpio-440 (                    |red:disk            ) out lo
     gpio-441 (                    |green:disk          ) out lo
     gpio-442 (                    |home                ) in  lo
     gpio-446 (                    |menu                ) in  lo
     gpio-453 (                    |gpio-fan            ) out lo ACTIVE LOW
     gpio-457 (                    |standby             ) out lo
     gpio-460 (                    |standby             ) out lo
     gpio-488 (                    |PHY reset           ) out lo ACTIVE LOW


Toggling the Fan
-------------------

* Turn the fan ON.

  .. code-block:: none
   :caption: Target (Linux)

   echo 1 > /sys/class/thermal/cooling_device0/cur_state

.. note::
    Run the command above 3-4 times to have the fan stay ON consistently.

* Turn the fan OFF.

  .. code-block:: none
     :caption: Target (Linux)

     echo 0 > /sys/class/thermal/cooling_device0/cur_state


Enabling a proper Thermal Governor
----------------------------------

If your application includes a GPIO-based fan, PHYTEC recommends enabling the bang-bang thermal governor as the default setting. This governor uses hysteresis to manage fan state transitions, preventing abrupt on/off cycling and enabling smoother control for fans that only support binary on/off operation, rather than variable speed throttling.

Update the current thermal governor strategy to bang-bang using the command below:

  .. code-block:: none
   :caption: Target (Linux)

   echo bang_bang > /sys/class/thermal/thermal_zone0/policy

.. note::
  To enable the bang-bang thermal governor by default, recompile the kernel with CONFIG_THERMAL_DEFAULT_GOV_BANG_BANG=y in the menuconfig configuration. For further details, please refer to the guide: |ref-modify-bsp|.