← Kernel Series DUJINLABS.COM

Driver / Device · Linux 6.18.37 LTS · source + diagram note

device tree

최신 LTS 기준: kernel.org longterm 6.18.37 기준으로 파일 좌표와 링크를 맞춘 문C식 독해 노트입니다. of_node, compatible matching, platform device. 박사 과정/커널 연구자 기준으로, API 설명보다 invariant, 동시성, lifetime, 성능 모델을 중심에 둔다.

읽는 지도

driver/device 코드는 abstract device model을 concrete register programming sequence로 연결한다. probe가 호출된다는 사실보다 probe가 호출될 수 있는 dependency graph를 먼저 읽어야 한다.

먼저 볼 것

함수 이름보다 입력 객체와 출력 객체를 먼저 본다. 이 토픽에서 어떤 구조체가 생성, 연결, publish, retire되는지 표시한다.

다음에 볼 것

정상 경로와 실패 경로를 같은 무게로 본다. kernel code의 품질은 성공 path보다 error unwind, hotplug, teardown에서 더 잘 드러난다.

그림 1. device tree 이 kernel 안에서 놓이는 위치
firmware descriptionDT/ACPI node, resources, compatible
driver corebus, device, driver, match
probeclk/reset/regulator/irq/mmio
runtimePM, IRQ handler, remove/shutdown

왼쪽은 입력 또는 상위 계층이고, 오른쪽으로 갈수록 실제 상태 변경이 커진다. 문C식으로 읽을 때는 이 그림을 먼저 머리에 놓고 코드 조각을 끼워 넣는다.

원본 코드 좌표

Linux 6.18.37 LTS에서 열 파일

원본 코드:
Linux 6.18.37 LTS: drivers/of/base.c
Linux 6.18.37 LTS: drivers/of/platform.c
Linux 6.18.37 LTS: drivers/of/fdt.c
Linux 6.18.37 LTS: include/linux/of.h

설명: 첫 파일은 보통 진입 함수가 있는 곳이고, 나머지는 구조체 정의, architecture glue, callback 구현을 확인할 때 같이 연다. 파일을 여러 개 놓고 봐야 이 토픽의 boundary가 보인다.

대표 코드

of_platform_populate

원본 코드: drivers/of/platform.c, around line 471
	return rc;
}
EXPORT_SYMBOL(of_platform_bus_probe);

/**
 * of_platform_populate() - Populate platform_devices from device tree data
 * @root: parent of the first level to probe or NULL for the root of the tree
 * @matches: match table, NULL to use the default
 * @lookup: auxdata table for matching id and platform_data with device nodes
 * @parent: parent to hook devices from, NULL for toplevel
 *
 * Similar to of_platform_bus_probe(), this function walks the device tree
 * and creates devices from nodes.  It differs in that it follows the modern
 * convention of requiring all device nodes to have a 'compatible' property,
 * and it is suitable for creating devices which are children of the root
 * node (of_platform_bus_probe will only create children of the root which
 * are selected by the @matches argument).
 *
 * New board support should be using this function instead of
 * of_platform_bus_probe().
 *
 * Return: 0 on success, < 0 on failure.
 */
int of_platform_populate(struct device_node *root,
			const struct of_device_id *matches,
			const struct of_dev_auxdata *lookup,
			struct device *parent)
{
	struct device_node *child;
	int rc = 0;

	root = root ? of_node_get(root) : of_find_node_by_path("/");
	if (!root)
		return -EINVAL;

	pr_debug("%s()\n", __func__);
	pr_debug(" starting at: %pOF\n", root);

	device_links_supplier_sync_state_pause();
	for_each_child_of_node(root, child) {

읽는 법: 이 절편에서 먼저 볼 것은 return 값이 아니라 상태 변경이다. 어떤 lock을 잡은 뒤 어떤 필드를 바꾸는지, 실패하면 어느 label로 빠지는지, 그리고 바뀐 상태를 다음 호출자가 어떤 전제로 소비하는지 표시한다.

of_find_node_by_path

원본 코드: drivers/of/base.c, around line 404
int of_machine_is_compatible(const char *compat)
{
	struct device_node *root;
	int rc = 0;

	root = of_find_node_by_path("/");
	if (root) {
		rc = of_device_is_compatible(root, compat);
		of_node_put(root);
	}
	return rc;
}
EXPORT_SYMBOL(of_machine_is_compatible);

/**
 *  __of_device_is_available - check if a device is available for use
 *
 *  @device: Node to check for availability, with locks already held
 *
 *  Return: True if the status property is absent or set to "okay" or "ok",
 *  false otherwise
 */
static bool __of_device_is_available(const struct device_node *device)
{
	const char *status;
	int statlen;

	if (!device)
		return false;

	status = __of_get_property(device, "status", &statlen);
	if (status == NULL)
		return true;

	if (statlen > 0) {
		if (!strcmp(status, "okay") || !strcmp(status, "ok"))
			return true;
	}

	return false;

읽는 법: 이 절편에서 먼저 볼 것은 return 값이 아니라 상태 변경이다. 어떤 lock을 잡은 뒤 어떤 필드를 바꾸는지, 실패하면 어느 label로 빠지는지, 그리고 바뀐 상태를 다음 호출자가 어떤 전제로 소비하는지 표시한다.

함수별 독해

firmware가 제공한 hardware description을 device node, resource, irq, platform_device로 변환하는 binding 계층이다.

이 섹션은 원본 코드 발췌를 함수 이름 단위로 끊어, 각 함수가 어떤 전제 조건을 만들고 다음 함수가 무엇을 소비하는지 추적한다.

그림 2. device tree 함수 체인과 관찰 지점
entrycaller가 넘기는 객체와 context를 확정
of_platform_populateflat tree에서 live tree 생성
of_find_node_by_pathcompatible 기반 probe
observable statetracepoint, counter, sysfs/proc에서 확인되는 결과

각 노드는 독립 함수가 아니라 전제 조건을 생산하고 소비하는 연결점이다. 코드를 읽을 때는 노드 사이에서 어떤 필드가 바뀌는지 표시한다.

1. of_platform_populate

of_platform_populate 주변에서는 device_node를 중심으로 본다. 이 필드는 DT node object 역할을 하므로, 함수가 끝날 때 FDT scanned 상태가 실제로 성립했는지 확인해야 한다.

원본 코드에서 볼 순서는 입력 범위 검증, 중심 필드 갱신, 다른 계층에 보이는 publish 지점, 실패 시 되돌림 순서다. 이 네 칸이 맞아야 다음 함수가 flat tree에서 live tree 생성을 전제로 삼을 수 있다.

자주 틀리는 해석: DT에 적혀 있으면 driver가 자동으로 probe된다고 봄

2. of_find_node_by_path

of_find_node_by_path 주변에서는 compatible를 중심으로 본다. 이 필드는 driver match string 역할을 하므로, 함수가 끝날 때 driver match 상태가 실제로 성립했는지 확인해야 한다.

원본 코드에서 볼 순서는 입력 범위 검증, 중심 필드 갱신, 다른 계층에 보이는 publish 지점, 실패 시 되돌림 순서다. 이 네 칸이 맞아야 다음 함수가 compatible 기반 probe을 전제로 삼을 수 있다.

자주 틀리는 해석: #address-cells/#size-cells 해석을 생략함

함수입력상태 변경검증 질문
of_platform_populatedevice_node, caller context, subsystem 전제 조건FDT scanned: flat tree에서 live tree 생성DT에 적혀 있으면 driver가 자동으로 probe된다고 봄 문제를 코드상 어느 조건문 또는 error label에서 분리하는가
of_find_node_by_pathcompatible, caller context, subsystem 전제 조건driver match: compatible 기반 probe#address-cells/#size-cells 해석을 생략함 문제를 코드상 어느 조건문 또는 error label에서 분리하는가

구조체 / 필드 해설

여기서는 “어떤 구조체가 있다”가 아니라 그 필드가 어느 단계에서 쓰기 가능하고 어느 단계부터 관찰 가능한지를 본다. 박사급 리뷰에서는 필드의 뜻보다 보호 규칙이 먼저다.

그림 3. device tree 핵심 필드 연결
device_nodeDT node object
compatibledriver match string
reg/interruptsresource specifier
phandledependency link

필드는 구조체 안에 흩어져 있지만, 실제 실행에서는 위 순서로 의미가 이어진다.

필드읽는 법확인
device_nodeDT node object누가 쓰고, 누가 보호하고, 언제 lifetime이 끝나는지 원본 코드에서 확인
compatibledriver match string누가 쓰고, 누가 보호하고, 언제 lifetime이 끝나는지 원본 코드에서 확인
reg/interruptsresource specifier누가 쓰고, 누가 보호하고, 언제 lifetime이 끝나는지 원본 코드에서 확인
phandledependency link누가 쓰고, 누가 보호하고, 언제 lifetime이 끝나는지 원본 코드에서 확인

상태 전이 그림

상태 전이를 따로 그리는 이유는 정상 path와 실패 path를 같은 표에서 보기 위해서다. 커널 regression은 흔히 마지막 상태가 아니라 중간 상태를 외부에 publish한 뒤 rollback하지 못해서 생긴다.

그림 4. device tree 상태 전이
FDT scannedflat tree에서 live tree 생성
nodes populatedplatform_device 생성
resources translatedaddress/irq 변환
driver matchcompatible 기반 probe

상태 전이는 단방향처럼 그렸지만, 실패 경로에서는 대부분 역순 rollback이 붙는다.

상태의미진입 조건깨지는 지점
FDT scannedflat tree에서 live tree 생성앞 단계 함수가 전제 조건을 만들고 error path가 정리된 뒤다음 단계가 이 상태를 너무 일찍 소비하거나 늦게 정리할 때
nodes populatedplatform_device 생성앞 단계 함수가 전제 조건을 만들고 error path가 정리된 뒤다음 단계가 이 상태를 너무 일찍 소비하거나 늦게 정리할 때
resources translatedaddress/irq 변환앞 단계 함수가 전제 조건을 만들고 error path가 정리된 뒤다음 단계가 이 상태를 너무 일찍 소비하거나 늦게 정리할 때
driver matchcompatible 기반 probe앞 단계 함수가 전제 조건을 만들고 error path가 정리된 뒤다음 단계가 이 상태를 너무 일찍 소비하거나 늦게 정리할 때
device tree review rule = state transition + owner transition + visibility transition

불변조건 / 실패 케이스

lifetime

device tree 의 중심 객체가 publish된 뒤에는 마지막 참조가 사라지기 전까지 teardown path가 모든 callback, timer, IRQ, worker와 경합하지 않아야 한다.

ordering

상태 필드를 바꾼 뒤 다른 CPU나 하위 계층이 관찰할 수 있다면 lock, barrier, refcount, RCU 중 어느 장치가 visibility를 보장하는지 확인한다.

error unwind

중간 단계 실패는 성공 단계의 역순으로 되돌아가야 한다. goto label이 많은 코드는 label 이름보다 어느 resource가 이미 획득됐는지를 표로 적는다.

bring-up symptom

embedded bring-up에서는 panic보다 silence, timeout, deferred probe, interrupt flood처럼 간접 증상으로 드러나는 경우가 많다.

주의

DT에 적혀 있으면 driver가 자동으로 probe된다고 봄

주의

#address-cells/#size-cells 해석을 생략함

주의

phandle dependency와 deferred probe를 분리하지 못함

계측 / 검증

계측은 printk 위치 경쟁이 아니라 가설 검증이다. 먼저 위 상태표에서 멈춘 state를 정하고, 그 state를 바꾸는 함수와 그 결과를 소비하는 함수를 동시에 본다.

도구보는 것해석
dtc -I fsdevice tree 의 상태 전이가 어느 지점에서 멈추는지 확인로그가 찍힌 위치를 완료 시점으로 단정하지 말고, 바로 앞뒤 필드 변경을 원본에서 확인
of:* tracepointsdevice tree 의 상태 전이가 어느 지점에서 멈추는지 확인로그가 찍힌 위치를 완료 시점으로 단정하지 말고, 바로 앞뒤 필드 변경을 원본에서 확인
devices_deferreddevice tree 의 상태 전이가 어느 지점에서 멈추는지 확인로그가 찍힌 위치를 완료 시점으로 단정하지 말고, 바로 앞뒤 필드 변경을 원본에서 확인
ftrace:of_platform_populatedevice tree 의 상태 전이가 어느 지점에서 멈추는지 확인로그가 찍힌 위치를 완료 시점으로 단정하지 말고, 바로 앞뒤 필드 변경을 원본에서 확인
기본 추적 골격:
# 예시: tracefs가 켜진 보드에서 토픽별 event를 좁혀 본다.
mount -t tracefs nodev /sys/kernel/tracing
echo function_graph > /sys/kernel/tracing/current_tracer
echo ':mod:*' > /sys/kernel/tracing/set_ftrace_filter
cat /sys/kernel/tracing/trace_pipe

연구 질문

  • device tree 의 state machine을 네 단계로 줄였을 때, 실제 코드에서 빠지는 intermediate state는 무엇인가?
  • device tree 의 fast path가 생략한 검사는 어느 init path 또는 slow path에서 보증되는가?
  • 실험으로 확인한다면 'DT에 적혀 있으면 driver가 자동으로 probe된다고 봄' 문제를 어떤 tracepoint와 counter로 분리할 수 있는가?
  • 실험으로 확인한다면 '#address-cells/#size-cells 해석을 생략함' 문제를 어떤 tracepoint와 counter로 분리할 수 있는가?