build/dts/api/bindings/mtd/zephyr,emu-eeprom.html · build/dts/api/bindings/mtd/zephyr,emu-eeprom.rst 공식 원문 ↗

Zephyr 3.7.0 · Devicetree · MTD · Zephyr-specific binding

Zephyr Flash-Backed Emulated EEPROM 바인딩

Flash partition 위에 구현한 emulated EEPROM의 geometry와 erase policy를 정의하는 30개 property schema입니다.

Official pathbuild/dts/api/bindings/mtd/zephyr,emu-eeprom.html
Source filebuild/dts/api/bindings/mtd/zephyr,emu-eeprom.rst
Source versionZephyr 3.7.0
TranslationFull · reviewed

본문 기준: Zephyr 3.7.0 LTS3 · 이후 유지보수 패치는 별도입니다.

Part 1

요약·해설

공식 원문 317줄과 property 30행을 전수 대조해 required byte capacity/page/partition·optional RAM acceleration·partition erase power-loss risk 제약을 보존했습니다.

Compatible

zephyr,emu-eeprom

Vendor

Zephyr-specific binding

Properties

30 rows

Interface

Flash partition-backed EEPROM + RAM buffering/erase policy

Part 2

접을 수 있는 영어 원문 전체

영어 원문 전체 펼치기
원문 SHA-256 E0BE233C7C589EEB53E1E8D9843849D2DAD853F3540CF4DB58E8C25993CA0342
: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:: zephyr,emu-eeprom
.. _dtbinding_zephyr_emu_eeprom:

zephyr,emu-eeprom
#################

Vendor: :ref:`Zephyr-specific binding <dt_vendor_zephyr>`

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



.. code-block:: none

   Zephyr Emulated EEPROM device

Properties
**********

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

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

                Total EEPROM size in bytes


             This property is **required**.

         * - ``read-only``
           - ``boolean``
           - .. code-block:: none

                Disable writes to the EEPROM


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

                Size of a page used to emulate EEPROM in flash


             This property is **required**.

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

                Flash partition used to store the emulated EEPROM data


             This property is **required**.

         * - ``rambuf``
           - ``boolean``
           - .. code-block:: none

                Enable a ram buffer of EEPROM size for improved read speed


         * - ``partition-erase``
           - ``boolean``
           - .. code-block:: none

                Delay erase until complete partition is used. This enables a
                ram buffer to allow data to be copied during the partition erase. If
                power is lost during the partition erase the data will be lost.





   .. group-tab:: Deprecated node specific properties

      Deprecated properties not inherited from the base binding file.

      (None)

   .. 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 "zephyr,emu-eeprom" 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


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






Part 3

한국어 전문 번역

zephyr,emu-eeprom

Vendor: Zephyr-specific binding

공식 설명

Zephyr Emulated EEPROM device입니다.

Flash를 EEPROM처럼 사용하는 계층

size, pagesize, backing flash partition, base compatible가 필수입니다. read-only, rambuf, partition-erase와 base reg는 선택입니다.

EEPROM API

Byte reads/writes

RAM buffer

Optional full-size cache

Emulation pages

pagesize records

Flash partition

Persistent backing store

partition-erase는 partition을 모두 쓸 때까지 erase를 늦추고 erase 중 data copy를 위해 RAM buffer를 사용합니다. 공식 원문이 경고하듯 partition erase 도중 전원이 끊기면 data가 손실될 수 있습니다. 이 옵션은 단순한 성능 switch가 아니라 power-fail behavior를 바꿉니다.

속성 전체 번역

공식 node 6개와 base 24개 property를 모두 번역했습니다.

노드 전용 속성 · 6개
이름형식설명과 제약
sizeint전체 EEPROM 용량이며 byte 단위입니다.
필수
read-onlyboolean설정하면 EEPROM write를 비활성화합니다.
pagesizeintFlash에서 EEPROM을 emulation할 때 사용하는 page 크기이며 byte 단위입니다.
필수
partitionphandleEmulated EEPROM data를 저장할 flash partition의 phandle입니다.
필수
rambufbooleanRead 성능을 높이기 위해 EEPROM 전체 크기의 RAM buffer를 활성화합니다.
partition-erasebooleanFlash partition 전체를 다 쓸 때까지 erase를 미룹니다. Partition erase 중 data copy를 위해 RAM buffer를 사용하며, erase 도중 전원이 끊기면 data를 잃을 수 있습니다.
Base binding property · 24개

공통 기본 바인딩에서 상속한 속성입니다. 이 compatible에서 사용하지 않는 속성도 공식 참조 문서에 실려 있으면 함께 표시합니다.

이름형식설명과 제약
wakeup-sourceboolean이 장치를 시스템 깨우기에 사용할 수 있음을 나타냅니다. 이 속성이 있으면 깨우기 지원 플래그가 설정됩니다. 기본 상태에서는 장치의 인터럽트로 시스템을 깨우지 않으며, 실행 중에 깨우기 기능을 활성화할 수 있습니다.
power-domainphandle장치가 속한 전원 도메인의 phandle입니다. 해당 전원 도메인이 일시 중단되거나 다시 동작하면 장치에 알림이 전달됩니다.
zephyr,pm-device-runtime-autoboolean초기화 함수 실행 후 장치의 런타임 전원 관리를 자동으로 설정합니다.
zephyr,disabling-power-statesphandles이 장치의 전원이 꺼지는 전원 상태 목록입니다.
statusstring장치의 동작 상태를 나타냅니다.
허용값: 'ok', 'okay', 'disabled', 'reserved', 'fail', 'fail-sss'
compatiblestring-array이 노드에 적용할 바인딩과 드라이버를 식별하는 compatible 문자열 목록입니다.
필수
regarray장치 레지스터의 주소 범위를 지정합니다.
reg-namesstring-array각 register space의 이름입니다.
interruptsarray장치에서 사용하는 인터럽트를 지정하는 목록입니다.
interrupts-extendedcompound인터럽트 컨트롤러의 phandle을 함께 지정하는 확장 형식의 인터럽트 명세입니다.
interrupt-namesstring-array각 interrupt의 이름입니다.
interrupt-parentphandle인터럽트 컨트롤러 노드를 가리키는 phandle입니다.
labelstring사람이 장치를 알아볼 수 있도록 붙이는 이름입니다. 과거에는 device_get_binding()의 인자로 사용했습니다.
사용 중단됨
clocksphandle-array클록 게이트 또는 클록 공급원을 지정하는 phandle 배열입니다.
clock-namesstring-array각 clock의 이름입니다.
#address-cellsint하위 노드의 reg 속성에서 주소를 나타내는 데 쓰는 셀 수입니다.
#size-cellsint하위 노드의 reg 속성에서 크기를 나타내는 데 쓰는 셀 수입니다.
dmasphandle-arrayDMA 채널을 지정하는 phandle 배열입니다.
dma-namesstring-array지정한 DMA 채널의 이름입니다.
io-channelsphandle-arrayI/O 채널을 지정하는 phandle 배열입니다.
io-channel-namesstring-array지정한 I/O 채널의 이름입니다.
mboxesphandle-array메일박스/IPM 채널을 지정하는 phandle 배열입니다.
mbox-namesstring-array지정한 메일박스/IPM 채널의 이름입니다.
zephyr,deferred-initboolean부팅할 때 장치를 자동으로 초기화하지 않습니다. 이후 device_init()를 호출해 직접 초기화해야 합니다.

Source

출처

영어 원문에는 문단, 문서 지시문, 표, 코드, 코드 심벌, 경로를 그대로 보존했습니다.