Microchip MCP251XFD SPI CAN FD binding

:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: microchip,mcp251xfd
.. _dtbinding_microchip_mcp251xfd:

microchip,mcp251xfd (on spi bus)
################################

Vendor: :ref:`Microchip Technology Inc. <dt_vendor_microchip>`

Description
***********



.. code-block:: none

   Microchip MCP251XFD SPI CAN FD controller

   The MCP251XFD node is defined on an SPI bus. An example
   configuration is:

   &mikrobus_spi {
       cs-gpios = <&mikrobus_header 2 GPIO_ACTIVE_LOW>;

       mcp2518fd_mikroe_mcp2518fd_click: mcp2518fd@0 {
           compatible = "microchip,mcp251xfd";
           status = "okay";

           spi-max-frequency = <18000000>;
           int-gpios = <&mikrobus_header 7 GPIO_ACTIVE_LOW>;
           reg = <0x0>;
           osc-freq = <40000000>;

       };
   };

Properties
**********

Top level properties
====================


These property descriptions apply to "microchip,mcp251xfd"
nodes themselves. This page also describes child node
properties in the following sections.

.. tabs::

   .. group-tab:: Node specific properties

      Properties not inherited from the base binding file.

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

         * - Name
           - Type
           - Details

         * - ``supply-gpios``
           - ``phandle-array``
           - .. code-block:: none

                GPIO specifier that controls power to the device.

                This property should be provided when the device has a dedicated
                switch that controls power to the device.  The supply state is
                entirely the responsibility of the device driver.

                Contrast with vin-supply.



         * - ``vin-supply``
           - ``phandle``
           - .. code-block:: none

                Reference to the regulator that controls power to the device.
                The referenced devicetree node must have a regulator compatible.

                This property should be provided when device power is supplied
                by a shared regulator.  The supply state is dependent on the
                request status of all devices fed by the regulator.

                Contrast with supply-gpios.  If both properties are provided
                then the regulator must be requested before the supply GPIOS is
                set to an active state, and the supply GPIOS must be set to an
                inactive state before releasing the regulator.



         * - ``spi-max-frequency``
           - ``int``
           - .. code-block:: none

                Maximum clock frequency of device's SPI interface in Hz


             This property is **required**.

         * - ``duplex``
           - ``int``
           - .. code-block:: none

                Duplex mode, full or half. By default it's always full duplex thus 0
                as this is, by far, the most common mode.
                Use the macros not the actual enum value, here is the concordance
                list (see dt-bindings/spi/spi.h)
                  0    SPI_FULL_DUPLEX
                  2048 SPI_HALF_DUPLEX



             Legal values: ``0``, ``2048``

         * - ``frame-format``
           - ``int``
           - .. code-block:: none

                Motorola or TI frame format. By default it's always Motorola's,
                thus 0 as this is, by far, the most common format.
                Use the macros not the actual enum value, here is the concordance
                list (see dt-bindings/spi/spi.h)
                  0     SPI_FRAME_FORMAT_MOTOROLA
                  32768 SPI_FRAME_FORMAT_TI



             Legal values: ``0``, ``32768``

         * - ``spi-cpol``
           - ``boolean``
           - .. code-block:: none

                SPI clock polarity which indicates the clock idle state.
                If it is used, the clock idle state is logic high; otherwise, low.



         * - ``spi-cpha``
           - ``boolean``
           - .. code-block:: none

                SPI clock phase that indicates on which edge data is sampled.
                If it is used, data is sampled on the second edge; otherwise, on the first edge.



         * - ``spi-hold-cs``
           - ``boolean``
           - .. code-block:: none

                In some cases, it is necessary for the master to manage SPI chip select
                under software control, so that multiple spi transactions can be performed
                without releasing it. A typical use case is variable length SPI packets
                where the first spi transaction reads the length and the second spi transaction
                reads length bytes.



         * - ``bitrate``
           - ``int``
           - .. code-block:: none

                Initial bitrate in bit/s. If this is unset, the initial bitrate is set to
                CONFIG_CAN_DEFAULT_BITRATE.



         * - ``sample-point``
           - ``int``
           - .. code-block:: none

                Initial sample point in per mille (e.g. 875 equals 87.5%).

                If this is unset (or if it is set to 0), the initial sample point will default to 75.0% for
                bitrates over 800 kbit/s, 80.0% for bitrates over 500 kbit/s, and 87.5% for all other
                bitrates.



         * - ``phys``
           - ``phandle``
           - .. code-block:: none

                Actively controlled CAN transceiver.

                Example:
                  transceiver0: can-phy0 {
                    compatible = "nxp,tja1040", "can-transceiver-gpio";
                    standby-gpios = <gpioa 0 GPIO_ACTIVE_HIGH>;
                    max-bitrate = <1000000>;
                    #phy-cells = <0>;
                  };

                  &can0 {
                    status = "okay";

                    phys = <&transceiver0>;
                  };



         * - ``bitrate-data``
           - ``int``
           - .. code-block:: none

                Initial data phase bitrate in bit/s.  If this is unset, the initial data phase bitrate is set
                to CONFIG_CAN_DEFAULT_BITRATE_DATA.



         * - ``sample-point-data``
           - ``int``
           - .. code-block:: none

                Initial data phase sample point in per mille (e.g. 875 equals 87.5%).

                If this is unset (or if it is set to 0), the initial sample point will default to 75.0% for
                bitrates over 800 kbit/s, 80.0% for bitrates over 500 kbit/s, and 87.5% for all other
                bitrates.



         * - ``osc-freq``
           - ``int``
           - .. code-block:: none

                Frequency of the external oscillator in Hz.


             This property is **required**.

         * - ``int-gpios``
           - ``phandle-array``
           - .. code-block:: none

                The interrupt signal from the controller is active low in push-pull mode.
                The property value should ensure the flags properly describe the signal
                that is presented to the driver.



             This property is **required**.

         * - ``pll-enable``
           - ``boolean``
           - .. code-block:: none

                Enables controller PLL, which multiplies input clock frequency by 10.
                This parameter also implicitly sets whether the clock is from the PLL
                output or directly from the oscillator.
                If this option is enabled the clock source is the PLL, otherwise its
                the oscillator.



         * - ``timestamp-prescaler``
           - ``int``
           - .. code-block:: none

                Prescaler value for computing the timestamps of received messages.
                The timestamp counter is derived from the internal clock divided by this value.
                Valid range is [1, 1024].



             Default value: ``1``

         * - ``sof-on-clko``
           - ``boolean``
           - .. code-block:: none

                Output start-of-frame (SOF) signal on the CLKO pin every time
                a Start bit of a CAN message is transmitted or received. If this option
                is not set, then an internal clock (typically 40MHz or 20MHz) will be
                output on CLKO pin instead.



         * - ``clko-div``
           - ``int``
           - .. code-block:: none

                The factor to divide the system clock for CLKO pin.


             Default value: ``10``

             Legal values: ``1``, ``2``, ``4``, ``10``



   .. group-tab:: Deprecated node specific properties

      Deprecated properties not inherited from the base binding file.

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

         * - Name
           - Type
           - Details

         * - ``bus-speed``
           - ``int``
           - .. code-block:: none

                Deprecated. This property has been renamed to bitrate.

                Initial bitrate in bit/s. If this is unset, the initial bitrate is set to
                CONFIG_CAN_DEFAULT_BITRATE.



         * - ``bus-speed-data``
           - ``int``
           - .. code-block:: none

                Deprecated. This property has been renamed to bitrate-data.

                Initial data phase bitrate in bit/s.  If this is unset, the initial data phase bitrate is set
                to CONFIG_CAN_DEFAULT_BITRATE_DATA.





   .. group-tab:: Base properties

      Properties inherited from the base binding file, which defines
      common properties that may be set on many nodes. Not all of these
      may apply to the "microchip,mcp251xfd" compatible.

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

         * - Name
           - Type
           - Details

         * - ``wakeup-source``
           - ``boolean``
           - .. code-block:: none

                Property to identify that a device can be used as wake up source.

                When this property is provided a specific flag is set into the
                device that tells the system that the device is capable of
                wake up the system.

                Wake up capable devices are disabled (interruptions will not wake up
                the system) by default but they can be enabled at runtime if necessary.



         * - ``power-domain``
           - ``phandle``
           - .. code-block:: none


                Power domain the device belongs to.

                The device will be notified when the power domain it belongs to is either
                suspended or resumed.



         * - ``zephyr,pm-device-runtime-auto``
           - ``boolean``
           - .. code-block:: none

                Automatically configure the device for runtime power management after the
                init function runs.



         * - ``zephyr,disabling-power-states``
           - ``phandles``
           - .. code-block:: none

                List of power states that will disable this device power.



         * - ``status``
           - ``string``
           - .. code-block:: none

                indicates the operational status of a device


             Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``

             See :ref:`dt-important-props` for more information.

         * - ``compatible``
           - ``string-array``
           - .. code-block:: none

                compatible strings


             This property is **required**.

             See :ref:`dt-important-props` for more information.

         * - ``reg``
           - ``array``
           - .. code-block:: none

                register space


             This property is **required**.

             See :ref:`dt-important-props` for more information.

         * - ``reg-names``
           - ``string-array``
           - .. code-block:: none

                name of each register space


         * - ``interrupts``
           - ``array``
           - .. code-block:: none

                interrupts for device


             See :ref:`dt-important-props` for more information.

         * - ``interrupts-extended``
           - ``compound``
           - .. code-block:: none

                extended interrupt specifier for device


         * - ``interrupt-names``
           - ``string-array``
           - .. code-block:: none

                name of each interrupt


         * - ``interrupt-parent``
           - ``phandle``
           - .. code-block:: none

                phandle to interrupt controller node


         * - ``label``
           - ``string``
           - .. code-block:: none

                Human readable string describing the device (used as device_get_binding() argument)



             See :ref:`dt-important-props` for more information.

             This property is **deprecated**.

         * - ``clocks``
           - ``phandle-array``
           - .. code-block:: none

                Clock gate information


         * - ``clock-names``
           - ``string-array``
           - .. code-block:: none

                name of each clock


         * - ``#address-cells``
           - ``int``
           - .. code-block:: none

                number of address cells in reg property


         * - ``#size-cells``
           - ``int``
           - .. code-block:: none

                number of size cells in reg property


         * - ``dmas``
           - ``phandle-array``
           - .. code-block:: none

                DMA channels specifiers


         * - ``dma-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of DMA channel specifiers


         * - ``io-channels``
           - ``phandle-array``
           - .. code-block:: none

                IO channels specifiers


         * - ``io-channel-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of IO channel specifiers


         * - ``mboxes``
           - ``phandle-array``
           - .. code-block:: none

                mailbox / IPM channels specifiers


         * - ``mbox-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of mailbox / IPM channel specifiers


         * - ``zephyr,deferred-init``
           - ``boolean``
           - .. code-block:: none

                Do not initialize device automatically on boot. Device should be manually
                initialized using device_init().






Child node properties
=====================

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

   * - Name
     - Type
     - Details

   * - ``min-bitrate``
     - ``int``
     - .. code-block:: none

          The minimum bitrate supported by the CAN transceiver in bits/s.



   * - ``max-bitrate``
     - ``int``
     - .. code-block:: none

          The maximum bitrate supported by the CAN transceiver in bits/s.



       This property is **required**.