ISA Drivers

ISA bus driver 도입 배경

문서 제목은 `ISA Drivers`입니다. 이 글은 Rene Herman이 작성한 초기 ISA bus driver commit message를 바탕으로 합니다.

ISA driver가 platform device를 사용하던 방식에서는 hardware를 찾지 못해 `probe()`가 실패해도 그 오류가 driver model 위로 전달되지 않아 ALSA ISA driver가 device registration, 즉 module load를 실패시킬 수 없는 문제가 있었습니다. 이에 별도 ISA bus를 두고 실제 device discovery에 `.match()` method를 사용하자는 설계가 제안되었습니다.

오래된 ISA hardware는 일반적으로 discoverable하지 않아서 driver 자신만 hardware를 찾을 수 있습니다. 따라서 `platform_bus`와 달리 `isa_bus`는 `match()`를 driver까지 전달합니다.

이 device들은 driver가 구동할 가능성이 있어 직접 생성할 때만 driver model에 존재합니다. 그 때문에 device creation도 ISA bus 내부로 감쌌습니다.

ALSA driver 등록 model

이 사용 model은 ALSA 측 Takashi Iwai와 Jaroslav Kysela가 동의했습니다. Old-ISA 전용 ALSA driver의 `module_init`과 `module_exit`는 각각 `isa_register_driver()`와 `isa_unregister_driver()` 호출만 남습니다.

static int __init alsa_card_foo_init(void)
{
        return isa_register_driver(&snd_foo_isa_driver, SNDRV_CARDS);
}

static void __exit alsa_card_foo_exit(void)
{
        isa_unregister_driver(&snd_foo_isa_driver);
}

다른 bus model과 유사한 lifecycle이 되며 ALSA ISA driver에 반복되던 initialization code를 많이 제거합니다.

isa_driver와 callback 인자

전달하는 `struct isa_driver`는 일반 driver structure로, `struct device_driver`를 embed하고 표준 `probe`, `remove`, `shutdown`, `suspend`, `resume` callback과 ISA 전용 `.match` callback을 가집니다.

예시의 `SNDRV_CARDS`는 `unsigned int ndev` parameter입니다. 생성할 device 수와 callback을 호출할 횟수를 나타냅니다.

`platform_driver` callback은 `platform_device`를 받지만 `isa_driver` callback은 `struct device *dev, unsigned int id` pair를 직접 받습니다. Device creation이 bus 내부에 있으므로 private `isa_dev`를 외부에 노출하지 않는 편이 더 깔끔합니다. Callback이 실제로 필요한 것은 `struct device`와 `id`뿐이며 이 형태가 callback code도 단순하게 만듭니다.

match와 probe 정책

추가된 `.match()` callback 덕분에 ISA driver는 load policy를 선택할 수 있습니다. 이전처럼 hardware가 모두 존재할 때만 등록을 유지하려면 옛 `.probe` logic 전체를 `.match`에 둘 수 있습니다.

Platform device 전환 직후처럼 hardware 여부와 관계없이 항상 load하려면 `.match()`를 제공하지 않고 기존처럼 `.probe()`에서 모든 작업을 수행할 수 있습니다.

더 정상적인 bus model을 따르려면 나중의 bind가 성공할 가능성이 있을 때 module을 load합니다. `.match()`에서는 사용자가 card를 enable했는지, port·IRQ·DMA 값이 제공되었는지 같은 prerequisite만 검사하고 실제 hardware setup은 `.probe()`가 맡습니다. 문서는 이 model을 가장 좋은 방식으로 권장합니다.

등록 API와 bus match 구현

ISA core가 export하는 function은 `isa_register_driver()`와 `isa_unregister_driver()` 두 개뿐입니다.

`isa_register_driver()`는 `struct device_driver`를 먼저 등록한 뒤 전달된 `ndev`만큼 반복해 device를 생성하고 등록합니다. 각 registration은 아래 ISA bus match method를 호출합니다.

int isa_bus_match(struct device *dev, struct device_driver *driver)
{
        struct isa_driver *isa_driver = to_isa_driver(driver);

        if (dev->platform_data == isa_driver) {
                if (!isa_driver->match ||
                        isa_driver->match(dev, to_isa_dev(dev)->id))
                        return 1;
                dev->platform_data = NULL;
        }
        return 0;
}

platform_data 기반 owner 확인

`isa_bus_match()`는 먼저 `dev->platform_data`가 현재 `isa_driver`를 가리키는지 확인해 이 device가 해당 driver가 만든 device인지 판별합니다. Platform device는 string을 비교하지만 ISA device 생성은 모두 내부에서 일어나므로 `isa_register_driver()`가 `dev->platform_data`를 `isa_driver` pointer 저장소로 사용하고 match에서 직접 비교합니다.

문서는 `platform_data`를 이 용도로 사용할 수 있다고 보며, 원하지 않는다면 pointer를 private `struct isa_dev`로 옮겨도 된다고 설명합니다.

Driver가 `.match`를 제공하지 않으면 즉시 match합니다. 제공했다면 `isa_driver->match(dev, id)` 결과로 결정합니다. Match하지 않으면 `dev->platform_data`를 `NULL`로 reset해 `isa_register_driver()`가 해당 device를 다시 unregister할 수 있게 알립니다.

Rollback·unregister·helper macro

등록 과정에서 오류가 발생하거나 device가 하나도 match하지 않으면 지금까지의 작업을 모두 되돌리고 원래 error 또는 `-ENODEV`를 반환합니다.

`isa_unregister_driver()`는 match된 device를 unregister한 뒤 driver 자체를 unregister합니다.

`module_isa_driver`는 module init/exit에서 특별한 작업을 하지 않는 ISA driver용 helper macro입니다. Boilerplate를 제거하며 module 하나에서 한 번만 사용할 수 있고 `module_init`과 `module_exit`를 대체합니다.

`max_num_isa_dev`는 ISA device의 address extent를 기준으로 I/O port address space에 등록할 수 있는 ISA device 최대 수를 계산하는 macro입니다.