아래 글에 대한 원문은 아래 링크임을 먼저 밝혀 둡니다.

https://learn.adafruit.com/introduction-to-the-beaglebone-black-device-tree/overview

 

Introduction to the BeagleBone Black Device Tree

The BeagleBone Black uses the Device Tree to describe the hardware for the system. It also uses it in user-space for accessing GPIO's, PWM, UART, SPI and more in real-time by using device tree overlays.

learn.adafruit.com

위 원문 내용을 간략하게 필요한 부분만 추려서 정리하였습니다.


Overview

Device Tree(DT) 그리고 Device Tree Overlay(DTO)는 하나의 시스템에서 하드웨어를 설명하는 하나의 방법이다. 이에 대한 예는 그 시스템이 UART와 어떻게 인터페이스 하는지, 그 핀들이 어떻게 Mux 되는지, 어떻게 그 디바이스를 enable하는지 그리고 어떻게 그 드라이버를 사용하는지를 설명하는 것이다.

참고로, 원래 BeagleBone은 DT를 사용하지 않았지만, 그 이후 출시된 BeagleBone Black(이하 BBB)이 Linux Kernel 3.8을 사용하면서 DT를 사용하게 되었다.

다음 내용으로 부터 그 개념들을 분석 하려고 시도할 것이고, 어떻게 그리고 왜 우리가 DT를 사용하기 원하는지에 대한 예제들을 보여 줄 것이다.

Device Tree Background

ARM component들을 둘러싼 리눅스 커널 안에서 과거 몇년 동안 리눅스를 사용한 ARM 시스템에서는 많은 혼동과 갈등이 있었고 이는 ARM 보드 파일들을 대체하는 평면 Device Tree를 사용하는 새로운 ARM 보드를 이끌어 냈다.

DT와 관련해 밝혀진 하나의 이슈는 DT가 run-time 동안 그 시스템(muxing pins, enabling devices 등등)을 수정이 필요한 Open embedded system으로 디자인 되지 않았다는 것이다. 그래서 Pantelis Antoniu는 하나의 솔루션을 구현 했는데, 이것은 device tree overlay들과 cape manager를 사용하는 것이다. 그 이후, Grant Likely는 user-space로 부터 run-time 동안 DT의 수정을 허용하는 것 "존재하는 dtb data format으로 부터 직접 확장"이었던 새로운 device tree overlay format에 대해 허용하는 시스템을 제안했다.

이에 대해 더 자세한 역사는 하기를 참고.

https://github.com/jadonk/validation-scripts/tree/master/test-capemgr
https://docs.google.com/document/d/17P54kZkZO_-JtTjrFuVz-Cp_RMMg7GB_8W9JK9sLKfA/pub

 

Beaglebone and the 3.8 Kernel

Beaglebone and the 3.8 Kernel Pantelis Antoniou <panto@antoniou-consulting.com> Additional content by Tom King <ka6sox@gmail.com> Matt Porter <matt.porter@linaro.org> v1.0 Introduction The Beaglebone Black is the new addition to the Linux ARM development b</matt.porter@linaro.org></ka6sox@gmail.com></panto@antoniou-consulting.com>

docs.google.com

 

Device Tree Overlays

아래는 BBB의 UART1 device에 대한 device tree overlay이다. 이것은 P9_24와 P9_26 핀들 위의 UART1을 알맞게 enable하기 위해 필요한 알아야 할 것들 모든것을 kernel에게 말하고 있다.

한 가지 확실히 해둘것은, register offset들과 mux mode들을 밝힐 수 있는 최신 데이터를 사용하고 있는지를 확실히 해둬야 한다. 참고로, 이 링크에서 좋은 reference가 될 수 있는 BoneScript pin reference를 찾을 수 있다. https://github.com/jadonk/bonescript/blob/master/src/bone.js

 

jadonk/bonescript

Scripting tools for BeagleBone and PocketBeagle. Contribute to jadonk/bonescript development by creating an account on GitHub.

github.com

- BBB UART1 Device Tree Overlay

/*
 * Copyright (C) 2013 CircuitCo
 *
 * Virtual cape for UART1 on connector pins P9.24 P9.26
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
/dts-v1/;
/plugin/;
 
/ {
   	compatible = "ti,beaglebone", "ti,beaglebone-black";
 
        /* identification */
        part-number = "BB-UART1";
        version = "00A0";
 
        /* state the resources this cape uses */
        exclusive-use =
                /* the pin header uses */
                "P9.24",        /* uart1_txd */
                "P9.26",        /* uart1_rxd */
                /* the hardware ip uses */
                "uart1";
 
        fragment@0 {
                target = <&am33xx_pinmux>;
                __overlay__ {
                        bb_uart1_pins: pinmux_bb_uart1_pins {
                                pinctrl-single,pins = <
                                        0x184 0x20 /* P9.24 uart1_txd.uart1_txd MODE0 OUTPUT (TX) */
                                        0x180 0x20 /* P9.26 uart1_rxd.uart1_rxd MODE0 INPUT (RX) */
                                >;
                        };
                };
        };
 
	fragment@1 {
                target = <&uart2>;	/* really uart1 */
                __overlay__ {
                        status = "okay";
                        pinctrl-names = "default";
                        pinctrl-0 = <&bb_uart1_pins>;
                };
        };
};

위에 표시된 overlay는 "tree structure of nodes and properties"이다.

이제 위의 oevlay를 하나씩 세분화하여 분석해본다.

첫 번째 섹션은 단지 옵션인 코멘드이지만, 주로 copyright/license 정보에 대한 그리고 이 코드가 무엇을 제안하는지를 이해하기 쉽게 하는 부분이다.

/*
 * Copyright (C) 2013 CircuitCo
 *
 * Virtual cape for UART1 on connector pins P9.24 P9.26
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

그 다음 두개 라인들은 dts 파일의 버젼과 그것을 플러그인을 설명해 준다.

/dts-v1/;
/plugin/;

그 다음 라인은 DT의 root node의 시작을 설명해 준다.

/ {

"compatible" 라인이 설명하는 것은 호환성이 가장 낮은 것 부터 시작하는, 함께 작업하기 위해 디자인된 DT overlay이다. 여기에 언급되지 않은 어떤 플랫폼들은 로드가 실패할 것이기 때문에, 우리가 지원하고 싶은 모든 플랫폼의 이름을 여기에 기입하는 것은 중요하다.

compatible = "ti,beaglebone", "ti,beaglebone-black";

다음 섹션인, part-number와 version은 알맞은 DT overlay가 로드 될 수 있게 보장하는 추가 안전 장치이다.

/* identification */
part-number = "BB-UART1";
version = "00A0";

exclusive-use 속성은 우리가 필요로 하는 자원들과 다른 어떤 overlay들이 그런 자원들을 사용하는 것을 피하기위해 기입을 하는 것이다. 이 경우, 우리는 P9.24과 P9.26을 UART1 디바이스로 사용하고 있다.

/* state the resources this cape uses */
        exclusive-use =
                /* the pin header uses */
                "P9.24",        /* uart1_txd */
                "P9.26",        /* uart1_rxd */
                /* the hardware ip uses */
                "uart1";

그 다음으로는 device tree fragment들이다. 이것들은 overlay할 타겟을 설명하고 그리고 나서 각각의 fragment는 mux pin들 이거나 또는 enable device들로 사용자 지정 할 것이다. 아래 fragment는 복잡해 보이지만 그렇게 나쁘진 않다. 첫 번째는 이 fragment의 Target이 overlay 될 예정이라는 것을 우리가 설정하고 있다는 것이다. 이 경우, pinctrl-single 드라이버와 호환되는 am33x_pinmux 이다. 어떻게 이 드라이버를 사용하지에 대한 예제들은 pinctrl-single documentation page에서 찾을 수 있다.

그 다음 라인은 __overlay__ node 그 자신이다. 해당 노드 내부에 그 첫 번째 속성은 다음 fragment(bb_uart1_pins)에 사용 될 것이고, pinctrl-single 드라이버에 의해 조정되는 그 핀들 muxing에 대한 정의를 포함한다. 우리는 그 documentation page의 설명을 통해 어떻게 설정 할지를 알 수 있다.

  • pinctrl-single에 대한 pin configuration node들은 pinctrl register offset과 pinctrl-single,pins에 사용되는 value 쌍으로서 지정된다. 오직 pinctrl-single,function-mask에 지정된 비트들만이 업데이트 된다. 예를 들어, 디바이스 하나에 대한 핀 한개 설정은 pinctrl-single,pins=<0xdc 0x118>;로 완료될 것이다.여기서 0xdc는 그 디바이스 pinctrl register에 대한 pinctrl register base address로부터의 offset이고, 0x118은 pinctrl register의 희망하는 값을 포함한다.

pinctrl-single, pins 값 블럭 내부에서, 값들의 두 행은 UART1 디바이스를 위해 그 핀들을 설정하고 있다. 이 경우, MODE0로써 P9_24는 OUTPUT(Tx)가 될 것이다. 마찬가지로 MODE0로써 P_26은 INPUT(RX)가 될 것이다. 그 pin reference for BoneScript croos-referencing에 의해 P9_24를 0x184로 설정 할 필요가 있다고 말할 수 있다.

 

fragment@0 {
                target = <&am33xx_pinmux>;
                __overlay__ {
                        bb_uart1_pins: pinmux_bb_uart1_pins {
                                pinctrl-single,pins = <
                                        0x184 0x20 /* P9.24 uart1_txd.uart1_txd MODE0 OUTPUT (TX)  */
                                        0x180 0x20 /* P9.26 uart1_rxd.uart1_rxd MODE0 INPUT (RX)  */
                                >;
                        };
                };
        };

마지막 fragment는 그 uart device를 활성화 한다. overlay에 대한 그 target은 uart2(실제로 uart1으로 주석처리 됨)이다. 또한 이전 프래그먼트 속성 (bb_uart1_pins)을 참조하여 pinctrl 드라이버로 활성화 된 핀을 uart 장치에 매핑합니다.

	fragment@1 {
                target = <&uart2>;	/* really uart1 */
                __overlay__ {
                        status = "okay";
                        pinctrl-names = "default";
                        pinctrl-0 = <&bb_uart1_pins>;
                };
        };

이것은 매우 압도적이며 실제로 모호한 것처럼 보일 수 있다. 원하는 작업에 대한 새 오버레이를 만드는 가장 쉬운 방법은 이미 수행하려는 작업에 가까운 오버레이로 시작하는 것이다. 이것을 찾기 위한 가장 좋은 장소는 /lib/firmware (Angstrom)이며, 사용을 위해 이미 만들어진 오버레이를 잘 살펴보면 된다.

Exporting and Unexporting an Overlay

다음의 예제는 디폴트 Angstrom distribution을 사용한 데모이다.

먼저, 디폴트로 이용 가능한 모든 device tree를 보기위해 /lib/firmware를 확인해라.

root@beaglebone:~# cd /lib/firmware
root@beaglebone:/lib/firmware# ls -ltr
total 888
...

여기서 몇몇의 이용 가능한 overlay들을 볼 수 있다. 그 소스(dts) 그리고 컴파일된 파일(dtbo)는 해당 디렉토릭 안에 있다.

그 내용을 보기 위해 소스파일들 중에 하나를 열어 본다. 그 overlay 그들 자신은 잘 묘사되어 있고 잘 설명되어 있다.

자 이제 이전 페이지를 통해 살펴 봤던 BB-UART1-00A0.dts 파일을 사용한다.

우리는 .dts 파일을 볼 수 있었지만, 우리는 그것이 포함한 것을 이미 알고 있다. 그곳에 우리가 이용 가능한 이미 컴파일된 .dtbo 파일이 있다는 그 사실의 이점을 이용해 보자. 미래 섹션에서 우리가 소유한 것 중 하나를 빌드하고 컴파일 할 것이다.

자, bone cape manager에 의해 활성화 된 overlay들을 볼 수 있는 곳으로 이동하자.

root@beaglebone:/lib/firmware# cd /sys/devices/bone_capemgr.*

우리가 그 숫자가 무엇인지 알 수 없으므로 위의 *가 필요하다. 그 것은 부팅 순서에 의존한다. /sys/devices/bone_capemgr.8/slots뿐만 아니라 /sys/devices/bone_capemgr.9/slots 경로를 본적이 있다. 특정 경로가 무엇인지 확인해야 한다.

다음은 그 슬롯 파일의 그 내용들을 cat 한다.

root@beaglebone:/sys/devices/bone_capemgr.8# cat slots

Anstrong installation을 매우 많이 조작해 본적이 없다면, 이것처럼 보일 것이다.

0: 54:PF--- 
1: 55:PF--- 
2: 56:PF--- 
3: 57:PF--- 
4: ff:P-O-L Bone-LT-eMMC-2G,00A0,Texas Instrument,BB-BONE-EMMC-2G
5: ff:P-O-L Bone-Black-HDMI,00A0,Texas Instrument,BB-BONELT-HDMI

BeagleBone docementaion에 의하면 최초 3 슬롯들은 그 cape들 위에서 EEPROM ID들로 할당되었다. 그 다음 2개는 boot시 로드되는 overlay들이다. 숫자 4는 Angstrom 배포판으로 부터 부팅할 가능성이 높게 빌트된 EMMC memory이다. 그 다섯번째 overlay는 HDMI component 활성화에 대한 것이다.

우리의 선호하는 UART1의 overlay처럼, 이제 또 다른 overlay를 내보낸다면, 숫자 6과 같이 리스트된 새로운 옵션을 볼 수 있을 것이다. 그 UART1 dtbo 파일 내보내기를 시도해 보자.

root@beaglebone:/sys/devices/bone_capemgr.8# echo BB-UART1 > slots

에코 출력인 "BB-UART1"을 취하고 있고, 그것을 slots 파일에 쓰고 있다. 왜냐하면, 그 overlay를 사용한 UART1에 대해 그 드라이버들과 디바이스 활성하기 위해서이다. 이제 그 overlay가 알맞게 로드되었는지 확인해 보자.

root@beaglebone:/sys/devices/bone_capemgr.8# cat slots

이제 UART1 device를 로드 하고, 준비가 됐다.

0: 54:PF--- 
1: 55:PF--- 
2: 56:PF--- 
3: 57:PF--- 
4: ff:P-O-L Bone-LT-eMMC-2G,00A0,Texas Instrument,BB-BONE-EMMC-2G
5: ff:P-O-L Bone-Black-HDMI,00A0,Texas Instrument,BB-BONELT-HDMI
6: ff:P-O-L Override Board Name,00A0,Override Manuf,BB-UART1

이제 우리는 UART1 디바이스 사용하기를 완료 했고, 다른 무언가에 대해 그런 핀들이 필요하다고 말해보자.

그 overlay를 제거하기 위한 하나의 방법은 BBB를 재시동 거는 것이다. 다른 방법은 overlay를 내보내는 것을 취소 하는 것이다.

다음 command를 실행하는 것으로 overlay를 내보내기 할 수 있다.

root@beaglebone:/sys/devices/bone_capemgr.8# echo -6 > slots

우리는 6번째로 리스트된 옵션을 가졌고, 그 이전에 '-'를 입력한다. 그리고 그 slots 파일에 쓴다.

한 가지 알아 두어야 할 것은 Angstrom의 6-20-2013 릴리즈에서 다양한 overlay들의 언로딩은 커널 패닉을 야기할 수 있고, capemgr를 예상할 수 없게 만들면서 ssh 세션을 잃는 것을 야기 한다. 이 문제가 해결 될때 까지 overlay들을 unload하기 위해 system을 재시동하는 것을 권장한다. 

이제 우리는 시스템 재시동은 overlay들을 unload하는 것을 야기할 것이라는 걸 알고있다. 시스템이 부트 업될때, 어떻게 하면 우리는 overlay들을 로드할 수 있을까?

이건 정말 간단한 문제이다. 우리가 필요로 하는 모든 작업은 BBB에 작은 FAT 파티션 안에 uEnv.txt에서 overlay들을 참조하는 것이다.

다음 과정은 UART1 overlay에 대해 이것을 어떻게 진행하는지 보여준다.

mkdir /mnt/boot
mount /dev/mmcblk0p1 /mnt/boot
nano /mnt/boot/uEnv.txt
#append this to the end of the single line of uEnv.txt (not on a new line):
capemgr.enable_partno=BB-UART1

 

Compiling an Overlay

이제 우리는 메뉴얼로 하나의 overlay를 활성화했다. SPI0 디바이스와 버스를 활성화하기에 대한 Adafruit BBIO 파이썬 라이브러리 안에 사용된 그리고 생성된 하나의 overlay를 취해보자. the Adafruit Github repository for Adafruit_BBIO에서 이 overlay의 최신 복사본을 찾을 수 있다.

아래는 우리가 컴파일 그리고 활성화에 사용할 SPI0에 대한 overlay 복사본이다.

/dts-v1/;
/plugin/;
 
/ {
    compatible = "ti,beaglebone", "ti,beaglebone-black";
 
    /* identification */
    part-number = "ADAFRUIT-SPI0";
 
    /* version */
    version = "00A0";
 
    fragment@0 {
        target = <&am33xx_pinmux>;
        __overlay__ {
            spi0_pins_s0: spi0_pins_s0 {
                pinctrl-single,pins = <
                  0x150 0x30 /* spi0_sclk, INPUT_PULLUP | MODE0 */
                  0x154 0x30 /* spi0_d0, INPUT_PULLUP | MODE0 */
                  0x158 0x10 /* spi0_d1, OUTPUT_PULLUP | MODE0 */
                  0x15c 0x10 /* spi0_cs0, OUTPUT_PULLUP | MODE0 */
                >;
            };
        };
    };
 
    fragment@1 {
        target = <&spi0>;
        __overlay__ {
             #address-cells = <1>;
             #size-cells = <0>;
 
             status = "okay";
             pinctrl-names = "default";
             pinctrl-0 = <&spi0_pins_s0>;
 
             spidev@0 {
                 spi-max-frequency = <24000000>;
                 reg = <0>;
                 compatible = "spidev";
             };
             spidev@1 {
                 spi-max-frequency = <24000000>;
                 reg = <1>;
                 compatible = "spidev";
             };
        };
    };
};

위의 오버레이를 빠르게 살펴보면, UART1에 대한 오버레이와 같이, 동일한 패턴을 따르는 것을 볼 수 있다. 그곳에는 두 개의 fragment들이 있으며 첫 번째것은 pinctrl-single 드라이버를 사용하여 핀을 mux합니다. 우리는 SPI0 핀 중 4 개를 사용하고 모든 것을 Mode 0으로 설정한다. 그런 다음 fragment@1은 적절한 핀들로 spi0 device를 대상으로하며 그리고 'spi-max-frequency'와 같은 spi device를 사용하는 것에 특수한 다양한 parameter들을 설정한다. spi-bus documentation에서 사용 가능한 옵션을 볼 수 있다.

Home 디렉토리로 이동하고 복사 그리고 새로운 파일을 붙여 넣기 하기 위해 nano를 연다. 아래와 이름과 마찬가지로 정확하게 저장해야 한다.

root@beaglebone:/tmp# cd ~
root@beaglebone:~# nano ADAFRUIT-SPI0-00A0.dts

다음으로, 우리는 device tree overlay 컴파일된 포맷(.dtdo)안에 이 파일을 컴파일 하기 위해 명령어를 실행한다.

dtc -O dtb -o ADAFRUIT-SPI0-00A0.dtbo -b 0 -@ ADAFRUIT-SPI0-00A0.dts

컴파일은 거의 즉각적이어야하며 새롭게 컴파일 된 파일로 끝나야 한다.

root@beaglebone:~# ls -ltr
...
-rw-r--r-- 1 root root 1255 Jul 29 14:33 ADAFRUIT-SPI0-00A0.dts
-rw-r--r-- 1 root root 1042 Jul 29 14:35 ADAFRUIT-SPI0-00A0.dtbo

오버레이를 컴파일하는 데 사용되는 옵션을 분석해 보자.

우선, device tree compiler (dtc)를 사용한다. DT overlay를 컴파일하는 데 요구되는 모든 것이 최신 Angstrom 배포판에 포함되어 있다.

  • -O dtb는 출력 형식이다. device tree binaries를 출력하고 있다.
  • -o는 출력 파일 이름이다.
  • -b 0은 physical boot CPU를 설정한다. (0)
  • -@은 overlay의 동적 DT 로딩의 일부로 하나의 심볼 노드를 생성한다.

컴파일러가 누락 된-@ 플래그에 대해 complain할 경우 충분히 새로운 dtc 버전이 없는지 알 수 있다. 다음을 실행하여 dtc 업그레이드를 시도 할 수 있다 (현재 우분투에서 수행해야 할 수도 있음).

wget -c https://raw.githubusercontent.com/RobertCNelson/tools/master/pkgs/dtc.sh
chmod +x dtc.sh
./dtc.sh

+ Recent posts