요약·해설과 원문, 전문 번역을 서로 분리했습니다. API 이름, symbol, source path는 원문 표기를 사용합니다.
1. 요약·해설
원문의 핵심 논리와 kernel programming 관점의 보충 설명입니다. 아래의 전문 번역과는 별도로 작성했습니다.
2. 영어 원문 전체
번역 기준이 된 Linux v6.18.37 원문입니다. 줄 번호는 이 버전의 파일 좌표입니다.
원문 전체 펼치기
.. SPDX-License-Identifier: GPL-2.0
=============================
Adding a new board to LinuxSH
=============================
Paul Mundt <[email protected]>
This document attempts to outline what steps are necessary to add support
for new boards to the LinuxSH port under the new 2.5 and 2.6 kernels. This
also attempts to outline some of the noticeable changes between the 2.4
and the 2.5/2.6 SH backend.
1. New Directory Structure
==========================
The first thing to note is the new directory structure. Under 2.4, most
of the board-specific code (with the exception of stboards) ended up
in arch/sh/kernel/ directly, with board-specific headers ending up in
include/asm-sh/. For the new kernel, things are broken out by board type,
companion chip type, and CPU type. Looking at a tree view of this directory
hierarchy looks like the following:
Board-specific code::
.
|-- arch
| `-- sh
| `-- boards
| |-- adx
| | `-- board-specific files
| |-- bigsur
| | `-- board-specific files
| |
| ... more boards here ...
|
`-- include
`-- asm-sh
|-- adx
| `-- board-specific headers
|-- bigsur
| `-- board-specific headers
|
.. more boards here ...
Next, for companion chips::
.
`-- arch
`-- sh
`-- cchips
`-- hd6446x
`-- hd64461
`-- cchip-specific files
... and so on. Headers for the companion chips are treated the same way as
board-specific headers. Thus, include/asm-sh/hd64461 is home to all of the
hd64461-specific headers.
Finally, CPU family support is also abstracted::
.
|-- arch
| `-- sh
| |-- kernel
| | `-- cpu
| | |-- sh2
| | | `-- SH-2 generic files
| | |-- sh3
| | | `-- SH-3 generic files
| | `-- sh4
| | `-- SH-4 generic files
| `-- mm
| `-- This is also broken out per CPU family, so each family can
| have their own set of cache/tlb functions.
|
`-- include
`-- asm-sh
|-- cpu-sh2
| `-- SH-2 specific headers
|-- cpu-sh3
| `-- SH-3 specific headers
`-- cpu-sh4
`-- SH-4 specific headers
It should be noted that CPU subtypes are _not_ abstracted. Thus, these still
need to be dealt with by the CPU family specific code.
2. Adding a New Board
=====================
The first thing to determine is whether the board you are adding will be
isolated, or whether it will be part of a family of boards that can mostly
share the same board-specific code with minor differences.
In the first case, this is just a matter of making a directory for your
board in arch/sh/boards/ and adding rules to hook your board in with the
build system (more on this in the next section). However, for board families
it makes more sense to have a common top-level arch/sh/boards/ directory
and then populate that with sub-directories for each member of the family.
Both the Solution Engine and the hp6xx boards are an example of this.
After you have setup your new arch/sh/boards/ directory, remember that you
should also add a directory in include/asm-sh for headers localized to this
board (if there are going to be more than one). In order to interoperate
seamlessly with the build system, it's best to have this directory the same
as the arch/sh/boards/ directory name, though if your board is again part of
a family, the build system has ways of dealing with this (via incdir-y
overloading), and you can feel free to name the directory after the family
member itself.
There are a few things that each board is required to have, both in the
arch/sh/boards and the include/asm-sh/ hierarchy. In order to better
explain this, we use some examples for adding an imaginary board. For
setup code, we're required at the very least to provide definitions for
get_system_type() and platform_setup(). For our imaginary board, this
might look something like::
/*
* arch/sh/boards/vapor/setup.c - Setup code for imaginary board
*/
#include <linux/init.h>
const char *get_system_type(void)
{
return "FooTech Vaporboard";
}
int __init platform_setup(void)
{
/*
* If our hardware actually existed, we would do real
* setup here. Though it's also sane to leave this empty
* if there's no real init work that has to be done for
* this board.
*/
/* Start-up imaginary PCI ... */
/* And whatever else ... */
return 0;
}
Our new imaginary board will also have to tie into the machvec in order for it
to be of any use.
machvec functions fall into a number of categories:
- I/O functions to IO memory (inb etc) and PCI/main memory (readb etc).
- I/O mapping functions (ioport_map, ioport_unmap, etc).
- a 'heartbeat' function.
- PCI and IRQ initialization routines.
- Consistent allocators (for boards that need special allocators,
particularly for allocating out of some board-specific SRAM for DMA
handles).
There are machvec functions added and removed over time, so always be sure to
consult include/asm-sh/machvec.h for the current state of the machvec.
The kernel will automatically wrap in generic routines for undefined function
pointers in the machvec at boot time, as machvec functions are referenced
unconditionally throughout most of the tree. Some boards have incredibly
sparse machvecs (such as the dreamcast and sh03), whereas others must define
virtually everything (rts7751r2d).
Adding a new machine is relatively trivial (using vapor as an example):
If the board-specific definitions are quite minimalistic, as is the case for
the vast majority of boards, simply having a single board-specific header is
sufficient.
- add a new file include/asm-sh/vapor.h which contains prototypes for
any machine specific IO functions prefixed with the machine name, for
example vapor_inb. These will be needed when filling out the machine
vector.
Note that these prototypes are generated automatically by setting
__IO_PREFIX to something sensible. A typical example would be::
#define __IO_PREFIX vapor
#include <asm/io_generic.h>
somewhere in the board-specific header. Any boards being ported that still
have a legacy io.h should remove it entirely and switch to the new model.
- Add machine vector definitions to the board's setup.c. At a bare minimum,
this must be defined as something like::
struct sh_machine_vector mv_vapor __initmv = {
.mv_name = "vapor",
};
ALIAS_MV(vapor)
- finally add a file arch/sh/boards/vapor/io.c, which contains definitions of
the machine specific io functions (if there are enough to warrant it).
3. Hooking into the Build System
================================
Now that we have the corresponding directories setup, and all of the
board-specific code is in place, it's time to look at how to get the
whole mess to fit into the build system.
Large portions of the build system are now entirely dynamic, and merely
require the proper entry here and there in order to get things done.
The first thing to do is to add an entry to arch/sh/Kconfig, under the
"System type" menu::
config SH_VAPOR
bool "Vapor"
help
select Vapor if configuring for a FooTech Vaporboard.
next, this has to be added into arch/sh/Makefile. All boards require a
machdir-y entry in order to be built. This entry needs to be the name of
the board directory as it appears in arch/sh/boards, even if it is in a
sub-directory (in which case, all parent directories below arch/sh/boards/
need to be listed). For our new board, this entry can look like::
machdir-$(CONFIG_SH_VAPOR) += vapor
provided that we've placed everything in the arch/sh/boards/vapor/ directory.
Next, the build system assumes that your include/asm-sh directory will also
be named the same. If this is not the case (as is the case with multiple
boards belonging to a common family), then the directory name needs to be
implicitly appended to incdir-y. The existing code manages this for the
Solution Engine and hp6xx boards, so see these for an example.
Once that is taken care of, it's time to add an entry for the mach type.
This is done by adding an entry to the end of the arch/sh/tools/mach-types
list. The method for doing this is self explanatory, and so we won't waste
space restating it here. After this is done, you will be able to use
implicit checks for your board if you need this somewhere throughout the
common code, such as::
/* Make sure we're on the FooTech Vaporboard */
if (!mach_is_vapor())
return -ENODEV;
also note that the mach_is_boardname() check will be implicitly forced to
lowercase, regardless of the fact that the mach-types entries are all
uppercase. You can read the script if you really care, but it's pretty ugly,
so you probably don't want to do that.
Now all that's left to do is providing a defconfig for your new board. This
way, other people who end up with this board can simply use this config
for reference instead of trying to guess what settings are supposed to be
used on it.
Also, as soon as you have copied over a sample .config for your new board
(assume arch/sh/configs/vapor_defconfig), you can also use this directly as a
build target, and it will be implicitly listed as such in the help text.
Looking at the 'make help' output, you should now see something like:
Architecture specific targets (sh):
======================= =============================================
zImage Compressed kernel image (arch/sh/boot/zImage)
adx_defconfig Build for adx
cqreek_defconfig Build for cqreek
dreamcast_defconfig Build for dreamcast
...
vapor_defconfig Build for vapor
======================= =============================================
which then allows you to do::
$ make ARCH=sh CROSS_COMPILE=sh4-linux- vapor_defconfig vmlinux
which will in turn copy the defconfig for this board, run it through
oldconfig (prompting you for any new options since the time of creation),
and start you on your way to having a functional kernel for your new
board.
3. 한국어 전문 번역
영어 원문의 문단 순서와 의미를 유지한 전체 번역입니다. 코드, 함수명, symbol과 URL은 원문 표기를 유지합니다.
LinuxSH에 새 board를 추가하는 문서
1-13Paul Mundt가 작성한 이 문서는 2.5 및 2.6 kernel 계열의 LinuxSH port에 새 board 지원을 추가하는 절차를 개괄합니다. 또한 2.4 backend와 2.5/2.6 SH backend 사이에서 눈에 띄게 바뀐 점을 설명합니다.
새 board별 directory 구조
14-45먼저 새 directory 구조를 이해해야 합니다. 2.4에서는 `stboards`를 제외한 board별 코드 대부분이 `arch/sh/kernel/`에, board별 header는 `include/asm-sh/`에 놓였습니다. 새 kernel에서는 board type, companion chip type, CPU type에 따라 코드를 분리합니다.
각 board 이름 아래에 구현 파일과 전용 header를 평행하게 둡니다.
companion chip directory 구조
46-59companion chip 코드도 별도 계층에 둡니다. 예를 들어 `hd64461` 전용 파일은 `arch/sh/cchips/hd6446x/hd64461/` 아래에 배치합니다.
chip family와 개별 chip을 차례로 구분합니다.
companion chip header도 board별 header와 같은 방식으로 취급합니다. 따라서 모든 `hd64461` 전용 header는 `include/asm-sh/hd64461`에 둡니다.
CPU family별 구현 분리
60-88CPU family 지원도 추상화되어 있습니다. kernel과 memory-management 구현 및 header를 SH-2, SH-3, SH-4 family별로 나눕니다.
각 CPU family가 고유한 generic 구현, cache/TLB 함수, header를 갖습니다.
CPU subtype 자체는 추상화하지 않습니다. 따라서 subtype 차이는 CPU family별 코드에서 계속 처리해야 합니다.
독립 board와 board family 추가
89-111추가할 board가 독립형인지, 작은 차이만 있고 board별 코드를 대부분 공유할 수 있는 family 구성원인지 먼저 결정합니다.
독립형이면 `arch/sh/boards/` 아래에 board directory를 만들고 build system 연결 규칙을 추가하면 됩니다. board family라면 공통 상위 directory를 만들고 그 아래에 각 family 구성원의 subdirectory를 두는 편이 적절합니다. Solution Engine과 hp6xx board가 이 방식의 예입니다.
새 `arch/sh/boards/` directory를 만든 뒤 board 전용 header가 둘 이상이라면 `include/asm-sh`에도 directory를 추가합니다. build system과 자연스럽게 연동하려면 두 directory 이름을 같게 하는 것이 좋습니다. board family라면 `incdir-y` override를 사용해 구성원 이름을 별도로 쓸 수 있습니다.
필수 setup 함수
112-146각 board는 `arch/sh/boards`와 `include/asm-sh/` 계층에 필요한 구성 요소를 제공해야 합니다. 가상 board를 예로 들면 setup code에는 최소한 `get_system_type()`과 `platform_setup()` 정의가 필요합니다.
/*
* arch/sh/boards/vapor/setup.c - Setup code for imaginary board
*/
#include <linux/init.h>
const char *get_system_type(void)
{
return "FooTech Vaporboard";
}
int __init platform_setup(void)
{
/*
* If our hardware actually existed, we would do real
* setup here. Though it's also sane to leave this empty
* if there's no real init work that has to be done for
* this board.
*/
/* Start-up imaginary PCI ... */
/* And whatever else ... */
return 0;
}이 가상 board가 실제로 쓰이려면 machine vector인 `machvec`에도 연결해야 합니다.
machvec 함수 범주와 기본 wrapper
147-166`machvec` 함수는 다음 범주로 나뉩니다.
- I/O memory용 I/O 함수(`inb` 등)와 PCI/main memory용 함수(`readb` 등)
- I/O mapping 함수(`ioport_map`, `ioport_unmap` 등)
- `heartbeat` 함수
- PCI 및 IRQ 초기화 routine
- 특수 allocator가 필요한 board용 consistent allocator, 특히 DMA handle을 board 전용 SRAM에서 할당하는 경우
`machvec` 함수는 시간이 지나며 추가되거나 제거되므로 현재 상태는 항상 `include/asm-sh/machvec.h`에서 확인해야 합니다.
kernel source 대부분은 `machvec` 함수를 조건 없이 참조하므로, boot 시 정의되지 않은 function pointer에는 generic routine을 자동으로 감쌉니다. dreamcast와 sh03처럼 매우 작은 `machvec`만 필요한 board도 있고, rts7751r2d처럼 거의 모든 항목을 정의해야 하는 board도 있습니다.
machine별 I/O header
167-186대부분의 board처럼 board별 정의가 최소라면 전용 header 하나로 충분합니다. `include/asm-sh/vapor.h`를 추가하고 `vapor_inb`처럼 machine 이름을 prefix로 붙인 I/O 함수 prototype을 선언합니다. machine vector를 채울 때 이 prototype이 필요합니다.
이 prototype은 board별 header에서 `__IO_PREFIX`를 적절히 설정하면 자동으로 생성할 수 있습니다.
#define __IO_PREFIX vapor
#include <asm/io_generic.h>여전히 legacy `io.h`를 가진 이식 대상 board는 해당 파일을 완전히 제거하고 새 model로 전환해야 합니다.
machine vector와 io.c
187-197board의 `setup.c`에 machine vector 정의를 추가합니다. 최소 정의는 다음과 같습니다.
struct sh_machine_vector mv_vapor __initmv = {
.mv_name = "vapor",
};
ALIAS_MV(vapor)machine별 I/O 함수가 별도 파일을 둘 만큼 많다면 `arch/sh/boards/vapor/io.c`를 추가해 해당 함수를 정의합니다.
build system 연결 개요
198-207관련 directory와 board별 코드를 준비했으면 build system에 연결해야 합니다. build system의 많은 부분은 동적으로 구성되므로 필요한 위치에 올바른 entry를 추가하면 됩니다.
Kconfig와 Makefile entry
208-225먼저 `arch/sh/Kconfig`의 `System type` menu 아래에 board entry를 추가합니다.
config SH_VAPOR
bool "Vapor"
help
select Vapor if configuring for a FooTech Vaporboard.그다음 `arch/sh/Makefile`에 추가합니다. 모든 board에는 build 대상이 되기 위한 `machdir-y` entry가 필요합니다. 값은 `arch/sh/boards`에서 보이는 board directory 이름이어야 하며, subdirectory라면 `arch/sh/boards/` 아래의 모든 parent directory도 열거해야 합니다.
machdir-$(CONFIG_SH_VAPOR) += vapor위 예는 모든 파일을 `arch/sh/boards/vapor/` directory에 배치했다는 전제입니다.
incdir-y와 machine type 검사
226-247build system은 `include/asm-sh`의 board header directory 이름도 같은 것으로 가정합니다. 여러 board가 공통 family에 속하는 경우처럼 이름이 다르면 그 directory 이름을 `incdir-y`에 암묵적으로 추가해야 합니다. Solution Engine과 hp6xx 기존 코드가 예입니다.
그다음 `arch/sh/tools/mach-types` 목록 끝에 machine type entry를 추가합니다. 이후 공통 코드 어디서든 다음과 같은 board 검사를 사용할 수 있습니다.
/* Make sure we're on the FooTech Vaporboard */
if (!mach_is_vapor())
return -ENODEV;`mach-types` entry가 대문자여도 `mach_is_boardname()` 검사의 board 이름은 자동으로 소문자가 됩니다. 이를 생성하는 script는 직접 읽을 수 있지만 상당히 복잡합니다.
새 board의 defconfig 제공
248-256마지막으로 새 board용 `defconfig`를 제공해야 합니다. 같은 board를 사용하는 다른 사람이 필요한 설정을 추측하지 않고 이 구성을 기준으로 삼을 수 있습니다.
예를 들어 sample `.config`를 `arch/sh/configs/vapor_defconfig`로 복사하면 이 이름을 build target으로 직접 사용할 수 있고 help text에도 자동으로 표시됩니다.
make help와 실제 build 명령
257-277`make help` 출력에는 다음과 같은 SH architecture target이 나타납니다.
압축 kernel image와 board별 defconfig target의 예입니다.
따라서 다음 명령을 실행할 수 있습니다.
$ make ARCH=sh CROSS_COMPILE=sh4-linux- vapor_defconfig vmlinux이 명령은 해당 board의 `defconfig`를 복사하고 `oldconfig`를 실행해 config 작성 이후 추가된 option을 묻고, 새 board에서 동작하는 kernel을 만드는 절차를 시작합니다.
요약과 해설
new-machine.rst:1-277문서는 SH board port를 source/header directory 구성, 필수 setup 함수, machine vector, build system 등록의 네 단계로 나눕니다. 독립 board와 family형 board의 directory 전략이 다르며, `machvec`의 미정의 callback은 boot 시 generic routine으로 보완됩니다.
예제 board `vapor`는 `get_system_type()`, `platform_setup()`, `sh_machine_vector`, `Kconfig`, `machdir-y`, `mach-types`, `vapor_defconfig`를 차례로 추가합니다. 경로와 kernel version 설명은 2.5/2.6 시대의 역사적 구조이므로 현재 tree에 적용할 때는 최신 source layout을 함께 확인해야 합니다.