4. デバイスバインディング

この章には、特定のタイプおよびクラスのデバイスがデバイスツリーでどのように表されるかについての、バインディングと呼ばれる要件が含まれています。 デバイスノードの互換性プロパティは、ノードが準拠する特定のバインディング（または複数のバインディング）を記述します。

バインディングは、他のそれぞれの拡張として定義できます。 たとえば、新しいバスタイプは、シンプルバスバインディングの拡張として定義できます。 この場合、互換性のあるプロパティには、各バインディングを識別するいくつかの文字列が含まれます（最も具体的なものから最も一般的なものまで）（2.3.1 章, compatible を参照）。

4.1. バインディングガイドライン

4.1.1. General Principles

デバイスの新しいデバイスツリー表現を作成するときは、デバイスの必要なプロパティと値を完全に説明するバインディングを作成する必要があります。 この一連のプロパティは、デバイスドライバにデバイスの必要な属性を提供するために十分に説明的である必要があります。

推奨されるプラクティスには次のようなものがあります。

  1. 2.3.1 章 で説明されている規則を使用して、互換性のある文字列を定義します。

  1. 新しいデバイスに適用可能な標準プロパティ (sect-standard-properties および sect-interrupts で定義) を使用します。 通常、この使用法には、少なくとも reg および interrupts プロパティが含まれます。

  1. 新しいデバイスが DTSpec で定義されたデバイス クラスの 1 つに適合する場合は、 4 章 (デバイス バインディング) で指定されている規則を使用します。

  1. 該当する場合は、 sect-misc-properties で指定されたその他のプロパティ規則を使用します。

  1. バインディングで新しいプロパティが必要な場合、プロパティ名の推奨形式は "<company>,<property-name>" です。 ここで、 ``<company>``は、OUI または、その作成者を識別する株式ティッカーのような短い一意の文字列でバインディングの作成者を識別します。

    例: "ibm,ppc-interrupt-server#s"

4.1.2. その他のプロパティ

このセクションでは、多くのタイプのデバイスおよびデバイスクラスに適用できる有用なプロパティのリストを定義します。 これらは、名前と使用法の標準化を容易にするためにここで定義されています。

4.1.2.1. clock-frequency プロパティ

表 4.1 clock-frequency プロパティ

プロパティ

clock-frequency

値のタイプ

<prop-encoded-array>

説明

クロックの周波数をHzで指定します。

値は、次の2つの形式のいずれかの <prop-encoded-array> です。

周波数を指定する1つの <u32> で構成される32ビット整数

周波数を指定する <u64> として表される64ビット整数

4.1.2.2. reg-shift プロパティ

表 4.2 reg-shift プロパティ

プロパティ

reg-shift

値のタイプ

<u32>

説明

reg-shift プロパティは、レジスタ間のバイト数を除いて、ほとんどの点で同一のデバイスを表すメカニズムを提供します。

reg-shift プロパティは、ディスクリートデバイスレジスタが互いにどれだけ離れているかをバイト単位で指定します。 個々のレジスタの場所は、式 「レジスタアドレス」<< reg-shift を使用して計算されます。 指定しない場合、デフォルト値は0です。

例えば、16540 UARTレジスタがアドレス 0x0、0x4、0x8、0xC、0x10、0x14、0x18、および0x1Cに配置されているシステムでは、 reg-shift=<2> プロパティを使用してレジスタの場所を指定します。

4.1.2.3. label プロパティ

表 4.3 label プロパティ

プロパティ

label

値のタイプ

<string>

説明

label プロパティは、デバイスを説明する人間が読める文字列を定義します。

特定のデバイスのバインディングは、そのデバイスのプロパティの正確な意味を指定します。

4.2. Serial devices

4.2.1. Serial Class Binding

The class of serial devices consists of various types of point to point serial line devices. Examples of serial line devices include the 8250 UART, 16550 UART, HDLC device, and BISYNC device. In most cases hardware compatible with the RS-232 standard fit into the serial device class.

I2C and SPI (Serial Peripheral Interface) devices shall not be represented as serial port devices because they have their own specific representation.

4.2.1.1. clock-frequency Property

表 4.4 clock-frequecy Property

Property

clock-frequency

Value type

<u32>

Description

Specifies the frequency in Hertz of the baud rate generator's input clock.

Example

clock-frequency = <100000000>;

4.2.1.2. current-speed Property

表 4.5 current-speed Property

Property

current-speed

Value type

<u32>

Description

Specifies the current speed of a serial device in bits per second. A boot program should set this property if it has initialized the serial device.

Example

115,200 Baud: current-speed = <115200>;

4.2.2. National Semiconductor 16450/16550 Compatible UART Requirements

Serial devices compatible to the National Semiconductor 16450/16550 UART (Universal Asynchronous Receiver Transmitter) should be represented in the devicetree using following properties.

表 4.6 ns16550 UART Properties

Property Name

Usage

Value Type

Definition

compatible

R

<string list>

Value shall include "ns16550".

clock-frequency

R

<u32>

Specifies the frequency (in Hz) of the baud rate generator’s input clock

current-speed

OR

<u32>

Specifies current serial device speed in bits per second

reg

R

<prop encoded array>

Specifies the physical address of the registers device within the address space of the parent bus

interrupts

OR

<prop encoded array>

Specifies the interrupts generated by this device. The value of the interrupts property consists of one or more interrupt specifiers. The format of an interrupt specifier is defined by the binding document describing the node’s interrupt parent.

reg-shift

O

<u32>

Specifies in bytes how far the discrete device registers are separated from each other. The individual register location is calculated by using following formula: "registers address" << reg-shift. If unspecified, the default value is 0.

virtual-reg

SD

<u32> or <u64>

See 2.3.7 章. Specifies an effective address that maps to the first physical address specified in the reg property. This property is required if this device node is the system’s console.

Usage legend: R=Required, O=Optional, OR=Optional but Recommended, SD=See Definition

注釈

All other standard properties (sect-standard-properties) are allowed but are optional.

4.3. ネットワークデバイス

ネットワークデバイスは、パケット指向の通信デバイスです。 このクラスのデバイスは、7層OSIモデルのデータリンク層（レイヤー2）を実装し、Media Access Control (MAC) アドレスを使用すると想定されています。 ネットワークデバイスの例には、イーサネット、FDDI、802.11、およびトークンリングが含まれます。

4.3.1. ネットワーククラスバインディング

4.3.1.1. address-bits プロパティ

表 4.7 address-bits プロパティ

プロパティ

address-bits

値のタイプ

<u32>

説明

このノードによって記述されたデバイスをアドレス指定するために必要なアドレスビット数を指定します。

このプロパティは、MAC アドレスのビット数を指定します。 指定しない場合、デフォルト値は 48 です。

例

address-bits = <48>;

4.3.1.2. local-mac-address プロパティ

表 4.8 local-mac-address プロパティ

プロパティ

local-mac-address

値のタイプ

16進数の配列としてエンコードされた <prop-encoded-array>

説明

このプロパティを含むノードによって記述されたネットワークデバイスに割り当てられた MAC アドレスを指定します。

例

local-mac-address = [ 00 00 12 34 56 78 ];

4.3.1.3. mac-address プロパティ

表 4.9 mac-address プロパティ

プロパティ

mac-address

値のタイプ

16進数の配列としてエンコードされた <prop-encoded-array>

説明

ブートプログラムによって最後に使用された MAC アドレスを指定します。

このプロパティは、ブートプログラムによってデバイスに割り当てられた MAC アドレスが local-mac-address プロパティと異なる場合に使用する必要があります。 このプロパティは、値が local-mac-address プロパティ値と異なる場合にのみ使用されます。

例

mac-address = [ 02 03 04 05 06 07 ];

4.3.1.4. max-frame-size Property

表 4.10 max-frame-size Property

Property

max-frame-size

Value type

<u32>

Description

Specifies maximum packet length in bytes that the physical interface can send and receive.

Example

max-frame-size = <1518>;

4.3.2. イーサネット固有の考慮事項

LAN 規格の IEEE 802.3 コレクション (まとめてイーサネットと呼ばれる) に基づくネットワーク デバイスは、ネットワーク デバイス クラスで指定されたプロパティに加えて、次のプロパティを使用してデバイス ツリーで表すことができます。

このセクションにリストされているプロパティは、ネットワーク デバイス クラスにリストされているプロパティを補強します。

4.3.2.1. max-speed プロパティ

表 4.11 max-speed プロパティ

Property

max-speed

Value type

<u32>

Description

デバイスがサポートする最大速度 (メガビット/秒で指定) を指定します。

Example

max-speed = <1000>;

4.3.2.2. phy-connection-type プロパティ

表 4.12 phy-connection-type プロパティ

Property

phy-connection-type

Value type

<string>

Description

イーサネット デバイスと物理層 (PHY) デバイス間のインターフェイス タイプを指定します。 このプロパティの値は、実装に固有です。

推奨値を次の表に示します。

Example

phy-connection-type = "mii";
表 4.13 phy-connection-type プロパティの定義済みの値

Connection type

Value

Media Independent Interface

mii

Reduced Media Independent Interface

rmii

Gigabit Media Independent Interface

gmii

Reduced Gigabit Media Independent

rgmii

rgmii with internal delay

rgmii-id

rgmii with internal delay on TX only

rgmii-txid

rgmii with internal delay on RX only

rgmii-rxid

Ten Bit Interface

tbi

Reduced Ten Bit Interface

rtbi

Serial Media Independent Interface

smii

Serial Gigabit Media Independent Interface

sgmii

Reverse Media Independent Interface

rev-mii

10 Gigabits Media Independent Interface

xgmii

Multimedia over Coaxial

moca

Quad Serial Gigabit Media Independent Interface

qsgmii

Turbo Reduced Gigabit Media Independent Interface

trgmii

4.3.2.3. phy-handle プロパティ

表 4.14 phy-handle プロパティ

Property

phy-handle

Value type

<phandle>

Description

このイーサネット デバイスに接続されている物理層 (PHY) デバイスを表すノードへの参照を指定します。 このプロパティは、イーサネット デバイスが物理層デバイスに接続されている場合に必要です。

Example

phy-handle = <&PHY0>;

4.4. Power ISA Open PIC Interrupt Controllers

This section specifies the requirements for representing Open PIC compatible interrupt controllers. An Open PIC interrupt controller implements the Open PIC architecture (developed jointly by AMD and Cyrix) and specified in The Open Programmable Interrupt Controller (PIC) Register Interface Specification Revision 1.2 [b18].

Interrupt specifiers in an Open PIC interrupt domain are encoded with two cells. The first cell defines the interrupt number. The second cell defines the sense and level information.

Sense and level information shall be encoded as follows in interrupt specifiers:

0 = low to high edge sensitive type enabled
1 = active low level sensitive type enabled
2 = active high level sensitive type enabled
3 = high to low edge sensitive type enabled
表 4.15 Open-PIC properties

Property Name

Usage

Value Type

Definition

compatible

R

<string>

Value shall include "open-pic"

reg

R

<prop encoded array>

Specifies the physical address of the registers device within the address space of the parent bus

interrupt-controller

R

<empty>

Specifies that this node is an interrupt controller

#interrupt-cells

R

<u32>

Shall be 2.

#address-cells

R

<u32>

Shall be 0.

Usage legend: R=Required, O=Optional, OR=Optional but Recommended, SD=See Definition

注釈

All other standard properties (sect-standard-properties) are allowed but are optional.

4.5. simple-bus Compatible Value

System-on-a-chip processors may have an internal I/O bus that cannot be probed for devices. The devices on the bus can be accessed directly without additional configuration required. This type of bus is represented as a node with a compatible value of "simple-bus".

表 4.16 simple-bus Compatible Node Properties

Property Name

Usage

Value Type

Definition

compatible

R

<string>

Value shall include "simple-bus".

ranges

R

<prop encoded array>

This property represents the mapping between parent address to child address spaces (see 2.3.8 章, ranges).

nonposted-mmio

O

<empty>

Specifies that direct children of this bus should use non-posted memory accesses (i.e. a non-posted mapping mode) for MMIO ranges.

Usage legend: R=Required, O=Optional, OR=Optional but Recommended, SD=See Definition