요약·해설과 원문, 전문 번역을 서로 분리했습니다. API 이름, symbol, source path는 원문 표기를 사용합니다.
1. 요약·해설
원문의 핵심 논리와 kernel programming 관점의 보충 설명입니다. 아래의 전문 번역과는 별도로 작성했습니다.
2. 영어 원문 전체
번역 기준이 된 Linux v6.18.37 원문입니다. 줄 번호는 이 버전의 파일 좌표입니다.
원문 전체 펼치기
.. SPDX-License-Identifier: GPL-2.0+
===============================
Client Driver API Documentation
===============================
.. contents::
:depth: 2
Serial Hub Communication
========================
.. kernel-doc:: include/linux/surface_aggregator/serial_hub.h
.. kernel-doc:: drivers/platform/surface/aggregator/ssh_packet_layer.c
:export:
Controller and Core Interface
=============================
.. kernel-doc:: include/linux/surface_aggregator/controller.h
.. kernel-doc:: drivers/platform/surface/aggregator/controller.c
:export:
.. kernel-doc:: drivers/platform/surface/aggregator/core.c
:export:
Client Bus and Client Device API
================================
.. kernel-doc:: include/linux/surface_aggregator/device.h
.. kernel-doc:: drivers/platform/surface/aggregator/bus.c
:export:
3. 한국어 전문 번역
영어 원문의 문단 순서와 의미를 유지한 전체 번역입니다. 코드, 함수명, symbol과 URL은 원문 표기를 유지합니다.
Client Driver API 문서 머리말
1-10이 문서는 `GPL-2.0+` SPDX license identifier를 사용하는 Surface Aggregator Client Driver API 문서입니다.
`contents` 지시문의 `:depth: 2` 옵션은 이 페이지의 section을 두 단계 깊이까지 목차로 구성합니다.
.. SPDX-License-Identifier: GPL-2.0+
===============================
Client Driver API Documentation
===============================
.. contents::
:depth: 2
Serial Hub Communication API
11-19Serial Hub Communication 영역은 `include/linux/surface_aggregator/serial_hub.h`에 정의된 API 문서를 포함합니다.
이어 `drivers/platform/surface/aggregator/ssh_packet_layer.c`에서 export된 kernel-doc 항목을 `:export:` 옵션으로 추출합니다.
Serial Hub Communication
========================
.. kernel-doc:: include/linux/surface_aggregator/serial_hub.h
.. kernel-doc:: drivers/platform/surface/aggregator/ssh_packet_layer.c
:export:
Controller와 Core Interface
20-31Controller and Core Interface 영역은 `include/linux/surface_aggregator/controller.h`의 kernel-doc을 포함합니다.
Controller 구현은 `drivers/platform/surface/aggregator/controller.c`에서 export된 API를 가져오고, core 구현은 `drivers/platform/surface/aggregator/core.c`에서 export된 API를 가져옵니다.
Controller and Core Interface
=============================
.. kernel-doc:: include/linux/surface_aggregator/controller.h
.. kernel-doc:: drivers/platform/surface/aggregator/controller.c
:export:
.. kernel-doc:: drivers/platform/surface/aggregator/core.c
:export:
Client Bus와 Client Device API
32-38Client Bus and Client Device API 영역은 `include/linux/surface_aggregator/device.h`에 정의된 client device API 문서를 포함합니다.
Bus 구현은 `drivers/platform/surface/aggregator/bus.c`에서 export된 API를 `:export:` 옵션으로 추출합니다.
Client Bus and Client Device API
================================
.. kernel-doc:: include/linux/surface_aggregator/device.h
.. kernel-doc:: drivers/platform/surface/aggregator/bus.c
:export:
요약과 해설
client-api.rst:1-38이 페이지는 Surface Aggregator client driver가 사용하는 공개 API 문서를 세 영역으로 구성합니다. Serial Hub communication, Controller와 Core interface, Client Bus와 Client Device API 각각에 대해 header의 kernel-doc과 구현 source에서 export된 API를 결합합니다.