← Kernel Series DUJINLABS.COM

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

platform driver

최신 LTS 기준: kernel.org longterm 6.18.37 기준으로 파일 좌표와 링크를 맞춘 문C식 독해 노트입니다. probe, resource, irq, regmap. 박사 과정/커널 연구자 기준으로, 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. platform driver 이 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/base/platform.c
Linux 6.18.37 LTS: drivers/base/dd.c
Linux 6.18.37 LTS: include/linux/platform_device.h

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

대표 코드

platform_driver_probe

원본 코드: drivers/base/platform.c, around line 889
		return 1;
	return 0;
}

/**
 * __platform_driver_probe - register driver for non-hotpluggable device
 * @drv: platform driver structure
 * @probe: the driver probe routine, probably from an __init section
 * @module: module which will be the owner of the driver
 *
 * Use this instead of platform_driver_register() when you know the device
 * is not hotpluggable and has already been registered, and you want to
 * remove its run-once probe() infrastructure from memory after the driver
 * has bound to the device.
 *
 * One typical use for this would be with drivers for controllers integrated
 * into system-on-chip processors, where the controller devices have been
 * configured as part of board setup.
 *
 * Note that this is incompatible with deferred probing.
 *
 * Returns zero if the driver registered and bound to a device, else returns
 * a negative error code and with the driver not registered.
 */
int __init_or_module __platform_driver_probe(struct platform_driver *drv,
		int (*probe)(struct platform_device *), struct module *module)
{
	int retval;

	if (drv->driver.probe_type == PROBE_PREFER_ASYNCHRONOUS) {
		pr_err("%s: drivers registered with %s can not be probed asynchronously\n",
			 drv->driver.name, __func__);
		return -EINVAL;
	}

	/*
	 * We have to run our probes synchronously because we check if
	 * we find any devices to bind to and exit with error if there
	 * are any.
	 */

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

platform_get_resource

원본 코드: drivers/base/platform.c, around line 43
	.init_name	= "platform",
};
EXPORT_SYMBOL_GPL(platform_bus);

/**
 * platform_get_resource - get a resource for a device
 * @dev: platform device
 * @type: resource type
 * @num: resource index
 *
 * Return: a pointer to the resource or NULL on failure.
 */
struct resource *platform_get_resource(struct platform_device *dev,
				       unsigned int type, unsigned int num)
{
	u32 i;

	for (i = 0; i < dev->num_resources; i++) {
		struct resource *r = &dev->resource[i];

		if (type == resource_type(r) && num-- == 0)
			return r;
	}
	return NULL;
}
EXPORT_SYMBOL_GPL(platform_get_resource);

struct resource *platform_get_mem_or_io(struct platform_device *dev,
					unsigned int num)
{
	u32 i;

	for (i = 0; i < dev->num_resources; i++) {
		struct resource *r = &dev->resource[i];

		if ((resource_type(r) & (IORESOURCE_MEM|IORESOURCE_IO)) && num-- == 0)
			return r;
	}
	return NULL;
}

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

함수별 독해

SoC memory-mapped IP driver가 platform_device와 match되어 resource를 얻고 probe에서 hardware를 초기화하는 경로다.

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

그림 2. platform driver 함수 체인과 관찰 지점
entrycaller가 넘기는 객체와 context를 확정
platform_driver_proberesource 획득과 register programming
platform_get_resourcecompatible/name 매칭
observable statetracepoint, counter, sysfs/proc에서 확인되는 결과

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

1. platform_driver_probe

platform_driver_probe 주변에서는 platform_driver를 중심으로 본다. 이 필드는 probe/remove callbacks 역할을 하므로, 함수가 끝날 때 probe 상태가 실제로 성립했는지 확인해야 한다.

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

자주 틀리는 해석: probe가 안 불릴 때 driver 코드만 봄

2. platform_get_resource

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

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

자주 틀리는 해석: devm을 모든 lifetime race 해결로 오해함

함수입력상태 변경검증 질문
platform_driver_probeplatform_driver, caller context, subsystem 전제 조건probe: resource 획득과 register programmingprobe가 안 불릴 때 driver 코드만 봄 문제를 코드상 어느 조건문 또는 error label에서 분리하는가
platform_get_resourceplatform_driver, caller context, subsystem 전제 조건match: compatible/name 매칭devm을 모든 lifetime race 해결로 오해함 문제를 코드상 어느 조건문 또는 error label에서 분리하는가

구조체 / 필드 해설

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

그림 3. platform driver 핵심 필드 연결
platform_deviceresource container
platform_driverprobe/remove callbacks
struct resourceMMIO/IRQ ranges
devm resourcesdevice lifetime-managed allocations

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

필드읽는 법확인
platform_deviceresource container누가 쓰고, 누가 보호하고, 언제 lifetime이 끝나는지 원본 코드에서 확인
platform_driverprobe/remove callbacks누가 쓰고, 누가 보호하고, 언제 lifetime이 끝나는지 원본 코드에서 확인
struct resourceMMIO/IRQ ranges누가 쓰고, 누가 보호하고, 언제 lifetime이 끝나는지 원본 코드에서 확인
devm resourcesdevice lifetime-managed allocations누가 쓰고, 누가 보호하고, 언제 lifetime이 끝나는지 원본 코드에서 확인

상태 전이 그림

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

그림 4. platform driver 상태 전이
device existsDT/board code가 platform_device publish
matchcompatible/name 매칭
proberesource 획득과 register programming
removereverse teardown

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

상태의미진입 조건깨지는 지점
device existsDT/board code가 platform_device publish앞 단계 함수가 전제 조건을 만들고 error path가 정리된 뒤다음 단계가 이 상태를 너무 일찍 소비하거나 늦게 정리할 때
matchcompatible/name 매칭앞 단계 함수가 전제 조건을 만들고 error path가 정리된 뒤다음 단계가 이 상태를 너무 일찍 소비하거나 늦게 정리할 때
proberesource 획득과 register programming앞 단계 함수가 전제 조건을 만들고 error path가 정리된 뒤다음 단계가 이 상태를 너무 일찍 소비하거나 늦게 정리할 때
removereverse teardown앞 단계 함수가 전제 조건을 만들고 error path가 정리된 뒤다음 단계가 이 상태를 너무 일찍 소비하거나 늦게 정리할 때
platform driver review rule = state transition + owner transition + visibility transition

불변조건 / 실패 케이스

lifetime

platform driver 의 중심 객체가 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처럼 간접 증상으로 드러나는 경우가 많다.

주의

probe가 안 불릴 때 driver 코드만 봄

주의

devm을 모든 lifetime race 해결로 오해함

주의

IRQ enable과 hardware clear ordering을 놓침

계측 / 검증

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

도구보는 것해석
ftrace:really_probeplatform driver 의 상태 전이가 어느 지점에서 멈추는지 확인로그가 찍힌 위치를 완료 시점으로 단정하지 말고, 바로 앞뒤 필드 변경을 원본에서 확인
devices_deferredplatform driver 의 상태 전이가 어느 지점에서 멈추는지 확인로그가 찍힌 위치를 완료 시점으로 단정하지 말고, 바로 앞뒤 필드 변경을 원본에서 확인
devres debugplatform driver 의 상태 전이가 어느 지점에서 멈추는지 확인로그가 찍힌 위치를 완료 시점으로 단정하지 말고, 바로 앞뒤 필드 변경을 원본에서 확인
cat /sys/bus/platform/devicesplatform driver 의 상태 전이가 어느 지점에서 멈추는지 확인로그가 찍힌 위치를 완료 시점으로 단정하지 말고, 바로 앞뒤 필드 변경을 원본에서 확인
기본 추적 골격:
# 예시: 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

연구 질문

  • platform driver 의 state machine을 네 단계로 줄였을 때, 실제 코드에서 빠지는 intermediate state는 무엇인가?
  • platform driver 의 fast path가 생략한 검사는 어느 init path 또는 slow path에서 보증되는가?
  • 실험으로 확인한다면 'probe가 안 불릴 때 driver 코드만 봄' 문제를 어떤 tracepoint와 counter로 분리할 수 있는가?
  • 실험으로 확인한다면 'devm을 모든 lifetime race 해결로 오해함' 문제를 어떤 tracepoint와 counter로 분리할 수 있는가?