요약·해설과 원문, 전문 번역을 서로 분리했습니다. API 이름, symbol, source path는 원문 표기를 사용합니다.
1. 요약·해설
원문의 핵심 논리와 kernel programming 관점의 보충 설명입니다. 아래의 전문 번역과는 별도로 작성했습니다.
2. 영어 원문 전체
번역 기준이 된 Linux v6.18.37 원문입니다. 줄 번호는 이 버전의 파일 좌표입니다.
원문 전체 펼치기
=======================
RapidIO Subsystem Guide
=======================
:Author: Matt Porter
Introduction
============
RapidIO is a high speed switched fabric interconnect with features aimed
at the embedded market. RapidIO provides support for memory-mapped I/O
as well as message-based transactions over the switched fabric network.
RapidIO has a standardized discovery mechanism not unlike the PCI bus
standard that allows simple detection of devices in a network.
This documentation is provided for developers intending to support
RapidIO on new architectures, write new drivers, or to understand the
subsystem internals.
Known Bugs and Limitations
==========================
Bugs
----
None. ;)
Limitations
-----------
1. Access/management of RapidIO memory regions is not supported
2. Multiple host enumeration is not supported
RapidIO driver interface
========================
Drivers are provided a set of calls in order to interface with the
subsystem to gather info on devices, request/map memory region
resources, and manage mailboxes/doorbells.
Functions
---------
.. kernel-doc:: include/linux/rio_drv.h
:internal:
.. kernel-doc:: drivers/rapidio/rio-driver.c
:export:
.. kernel-doc:: drivers/rapidio/rio.c
:export:
Internals
=========
This chapter contains the autogenerated documentation of the RapidIO
subsystem.
Structures
----------
.. kernel-doc:: include/linux/rio.h
:internal:
Enumeration and Discovery
-------------------------
.. kernel-doc:: drivers/rapidio/rio-scan.c
:internal:
Driver functionality
--------------------
.. kernel-doc:: drivers/rapidio/rio.c
:internal:
.. kernel-doc:: drivers/rapidio/rio-access.c
:internal:
Device model support
--------------------
.. kernel-doc:: drivers/rapidio/rio-driver.c
:internal:
PPC32 support
-------------
.. kernel-doc:: arch/powerpc/sysdev/fsl_rio.c
:internal:
Credits
=======
The following people have contributed to the RapidIO subsystem directly
or indirectly:
1. Matt Porter\ [email protected]
2. Randy Vinson\ [email protected]
3. Dan Malek\ [email protected]
The following people have contributed to this document:
1. Matt Porter\ [email protected]
3. 한국어 전문 번역
영어 원문의 문단 순서와 의미를 유지한 전체 번역입니다. 코드, 함수명, symbol과 URL은 원문 표기를 유지합니다.
소개, 알려진 문제와 제한
1-34이 문서의 제목은 'RapidIO Subsystem Guide'이며 저자는 Matt Porter입니다.
RapidIO는 embedded 시장을 겨냥한 기능을 갖춘 고속 switched fabric interconnect입니다. Switched fabric network를 통해 memory-mapped I/O와 message-based transaction을 모두 지원합니다.
RapidIO에는 PCI bus standard와 비슷한 표준 discovery mechanism이 있어 network의 device를 간단히 감지할 수 있습니다.
이 문서는 새 architecture에서 RapidIO를 지원하거나 새 driver를 작성하거나 subsystem 내부를 이해하려는 developer를 위한 자료입니다.
원문이 밝힌 알려진 bug는 없습니다. 다만 두 가지 제한이 있습니다. RapidIO memory region의 access와 management를 지원하지 않으며, multiple host enumeration도 지원하지 않습니다.
RapidIO driver interface
35-53Driver는 subsystem과 상호 작용하는 call 집합을 제공받습니다. 이 API로 device 정보를 수집하고 memory region resource를 요청·mapping하며 mailbox와 doorbell을 관리합니다.
Driver interface의 internal kernel-doc은 `include/linux/rio_drv.h`에서 가져옵니다. Export된 function documentation은 `drivers/rapidio/rio-driver.c`와 `drivers/rapidio/rio.c`에서 생성합니다.
원문의 `:internal:` option은 file 내부의 비공개 kernel-doc 항목을 포함하고, `:export:` option은 export된 API 설명을 포함하라는 Sphinx kernel-doc 지시입니다.
Subsystem 내부 구현 색인
54-92이 장은 RapidIO subsystem의 자동 생성 documentation을 모읍니다.
Core structure의 internal documentation은 `include/linux/rio.h`에서 생성합니다.
Enumeration과 discovery의 internal documentation은 `drivers/rapidio/rio-scan.c`에서 생성합니다.
Driver functionality는 `drivers/rapidio/rio.c`와 `drivers/rapidio/rio-access.c`의 internal documentation을 포함합니다.
Device model 지원은 `drivers/rapidio/rio-driver.c`의 internal documentation을, PPC32 지원은 `arch/powerpc/sysdev/fsl_rio.c`의 internal documentation을 사용합니다.
기여자
93-107RapidIO subsystem에 직접 또는 간접으로 기여한 사람은 Matt Porter `<[email protected]>`, Randy Vinson `<[email protected]>`, Dan Malek `<[email protected]>`입니다.
이 문서에는 Matt Porter `<[email protected]>`가 기여했습니다.
요약과 해설
rapidio.rst:1-107RapidIO는 embedded system용 고속 switched fabric으로 memory-mapped I/O와 message transaction을 지원합니다. 이 page는 사용자 설정법보다 architecture port, driver 작성, 내부 구현 탐색을 위한 source 색인에 가깝습니다.
현재 문서가 명시한 핵심 제한은 memory region access·management와 multiple host enumeration이 없다는 점입니다. 아래 표는 kernel-doc이 어느 구현 file에서 생성되는지 정리합니다.