: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:: atmel,sam-can
.. _dtbinding_atmel_sam_can:

atmel,sam-can
#############

Vendor: :ref:`Atmel Corporation <dt_vendor_atmel>`

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



.. code-block:: none

   Specialization of Bosch m_can CAN FD controller for Atmel SAM

Properties
**********

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


These property descriptions apply to "atmel,sam-can"
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

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

                Clock divider for the CAN core clock


             This property is **required**.

             Legal values: ``6``, ``12``, ``24``

         * - ``bosch,mram-cfg``
           - ``array``
           - .. code-block:: none

                Bosch M_CAN message RAM configuration. The cells in the array have the following format:

                <offset std-filter-elements ext-filter-elements rx-fifo0-elements rx-fifo1-elements
                rx-buffer-elements tx-event-fifo-elements tx-buffer-elements>

                The 'offset' is an address offset of the message RAM where the following elements start
                from. This is normally set to 0x0 when using a non-shared message RAM. The remaining cells
                specify how many elements are allocated for each filter type/FIFO/buffer.

                The Bosch M_CAN IP supports the following elements:
                11-bit Filter	 0-128 elements / 0-128 words
                29-bit Filter	  0-64 elements / 0-128 words
                Rx FIFO 0		    0-64 elements / 0-1152 words
                Rx FIFO 1		    0-64 elements / 0-1152 words
                Rx Buffers	    0-64 elements / 0-1152 words
                Tx Event FIFO	  0-32 elements / 0-64 words
                Tx Buffers	    0-32 elements / 0-576 words



             This property is **required**.

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

                Initial data phase bitrate in bit/s.



             This property is **required**.

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

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

                This property is required unless the timing is specified using time quanta based properties
                (`sjw-data`, `prop-seg-data`, `phase-seg1-data`, and `phase-seg2-data`).

                If this property is present, the time quanta based timing properties are ignored.



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

                Initial bitrate in bit/s.



             This property is **required**.

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

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

                This property is required unless the timing is specified using time quanta based properties
                (`sjw`, `prop-seg`, `phase-seg1`, and `phase-seg2`).

                If this property is present, the time quanta based timing properties are ignored.



         * - ``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>;
                  };



         * - ``pinctrl-0``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the first state. Content is specific to the
                selected pin controller driver implementation.



         * - ``pinctrl-1``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the second state. See pinctrl-0.



         * - ``pinctrl-2``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the third state. See pinctrl-0.



         * - ``pinctrl-3``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fourth state. See pinctrl-0.



         * - ``pinctrl-4``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fifth state. See pinctrl-0.



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

                Names for the provided states. The number of names needs to match the
                number of states.





   .. 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

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

                Initial time quanta of resynchronization jump width for the data phase (ISO11898-1:2015).

                Deprecated in favor of automatic calculation of a suitable default SJW based on existing
                timing parameters. Default of 1 matches the default value previously used for all in-tree CAN
                controller devicetree instances.

                Applications can still manually set the SJW using the CAN timing APIs.



             Default value: ``1``

         * - ``prop-seg-data``
           - ``int``
           - .. code-block:: none

                Initial time quanta of propagation segment for the data phase (ISO11898-1:2015). Deprecated in
                favor of setting advanced timing parameters from the application.



         * - ``phase-seg1-data``
           - ``int``
           - .. code-block:: none

                Initial time quanta of phase buffer 1 segment for the data phase (ISO11898-1:2015). Deprecated
                in favor of setting advanced timing parameters from the application.



         * - ``phase-seg2-data``
           - ``int``
           - .. code-block:: none

                Initial time quanta of phase buffer 2 segment for the data phase (ISO11898-1:2015). Deprecated
                in favor of setting advanced timing parameters from the application.



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

                Initial time quanta of resynchronization jump width (ISO 11898-1).

                Deprecated in favor of automatic calculation of a suitable default SJW based on existing
                timing parameters. Default of 1 matches the default value previously used for all in-tree CAN
                controller devicetree instances.

                Applications can still manually set the SJW using the CAN timing APIs.



             Default value: ``1``

         * - ``prop-seg``
           - ``int``
           - .. code-block:: none

                Initial time quanta of propagation segment (ISO 11898-1). Deprecated in favor of setting
                advanced timing parameters from the application.



         * - ``phase-seg1``
           - ``int``
           - .. code-block:: none

                Initial time quanta of phase buffer 1 segment (ISO 11898-1). Deprecated in favor of setting
                advanced timing parameters from the application.



         * - ``phase-seg2``
           - ``int``
           - .. code-block:: none

                Initial time quanta of phase buffer 2 segment (ISO 11898-1). Deprecated in favor of setting
                advanced timing parameters from the application.





   .. 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 "atmel,sam-can" compatible.

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

         * - Name
           - Type
           - Details

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

                register space


             This property is **required**.

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

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

                interrupts for device


             This property is **required**.

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

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

                name of each interrupt


             This property is **required**.

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

                Clock gate information


             This property is **required**.

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

                indicates the operational status of a device


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

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

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

                compatible strings


             This property is **required**.

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

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

                name of each register space


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

                extended interrupt specifier for device


         * - ``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:`zephyr:dt-important-props` for more information.

             This property is **deprecated**.

         * - ``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


         * - ``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.






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

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

   * - Name
     - Type
     - Details

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

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



       This property is **required**.