Device Drivers

Device driver 기본 구조

`struct device_driver`의 상세 정의는 해당 kerneldoc을 참고합니다.

정적 allocation

device driver는 statically allocated structure입니다. system에 한 driver가 지원하는 device가 여러 개 있을 수 있지만 `struct device_driver`는 특정 device instance가 아니라 driver 전체를 나타냅니다.

초기화 field

driver는 최소한 `name`과 `bus` field를 초기화해야 합니다. 적절한 internal linkage를 얻도록 제공되는 경우 `devclass` field도 초기화해야 하며, callback은 각각 optional이지만 가능한 한 많이 초기화하는 것이 좋습니다.

Generic과 bus-specific driver 선언

`struct device_driver` object는 정적으로 할당합니다. 다음은 eepro100 driver가 새 model로 완전히 변환되었다고 가정한 예제 선언입니다.

static struct device_driver eepro100_driver = {
       .name                = "eepro100",
       .bus                = &pci_bus_type,

       .probe                = eepro100_probe,
       .remove                = eepro100_remove,
       .suspend                = eepro100_suspend,
       .resume                = eepro100_resume,
};

대부분의 driver는 자신이 속한 bus가 일반화할 수 없는 bus-specific field를 가진 구조체를 사용하므로 새 model로 완전히 변환할 수 없습니다. 대표적인 예가 device ID 구조체입니다. driver는 보통 지원 ID 배열을 정의하며 형식과 비교 semantics가 완전히 bus-specific입니다. 이를 generic entity로 만들면 type safety를 잃으므로 bus-specific 구조체를 유지합니다.

bus-specific driver 정의에는 generic `struct device_driver`를 embedded member로 포함해야 합니다.

struct pci_driver {
       const struct pci_device_id *id_table;
       struct device_driver          driver;
};

eepro100의 bus-specific field까지 포함한 정의는 다음과 같습니다.

static struct pci_driver eepro100_driver = {
       .id_table       = eepro100_pci_tbl,
       .driver               = {
              .name                = "eepro100",
              .bus                = &pci_bus_type,
              .probe                = eepro100_probe,
              .remove                = eepro100_remove,
              .suspend        = eepro100_suspend,
              .resume                = eepro100_resume,
       },
};

embedded struct initializer syntax가 어색하거나 보기 좋지 않을 수 있지만 현재 목적을 달성하는 가장 좋은 방식입니다.

Driver 등록

::

  int driver_register(struct device_driver *drv);

driver는 startup 때 구조체를 등록합니다. bus-specific field가 없어 별도 bus driver 구조체가 없는 driver는 `driver_register()`에 `struct device_driver` pointer를 전달합니다. 그러나 대부분은 bus-specific 구조체를 가지므로 `pci_driver_register` 같은 bus registration function을 사용해야 합니다.

driver 구조체는 가능한 한 일찍 등록해야 합니다. core registration은 reference count와 lock을 포함한 `struct device_driver`의 여러 field를 초기화합니다. device model core와 bus driver는 이 field가 항상 유효하다고 가정하고 사용할 수 있습니다.

Transition bus driver wrapper

wrapper function을 정의하면 새 model로 쉽게 전환할 수 있습니다. driver는 generic 구조체를 무시하고 bus wrapper가 field를 채우게 할 수 있습니다. callback에는 bus가 generic callback을 정의해 driver의 bus-specific callback으로 전달합니다.

이 solution은 임시 용도입니다. class 정보를 driver에 넣으려면 결국 driver를 수정해야 합니다. 새 model로 바꾸면 infrastructure complexity와 code size를 줄일 수 있으므로 class 정보를 추가할 때 함께 변환하는 것이 좋습니다.

Bound device 목록 접근

object를 등록한 뒤에는 lock과 device 목록 같은 common field에 접근할 수 있습니다.

int driver_for_each_dev(struct device_driver *drv, void *data,
                        int (*callback)(struct device *dev, void *data));

`devices` field는 driver에 bind된 모든 device 목록입니다. LDM core helper는 driver가 제어하는 모든 device에 작업을 수행합니다. 각 node에 접근할 때 driver를 lock하고 각 device에 올바른 reference counting을 적용합니다.

Driver sysfs directory

driver를 등록하면 그 bus directory 아래에 sysfs directory를 만듭니다. driver는 여기서 debugging output toggle처럼 driver 전체 동작을 제어하는 userspace interface를 export할 수 있습니다.

향후 이 directory에는 driver가 지원하는 device directory를 가리키는 symlink를 담는 `devices` directory가 추가될 예정입니다.

probe callback과 deferred probe

::

        int        (*probe)        (struct device *dev);

`probe()`는 task context에서 bus의 rwsem을 lock한 채 driver가 device에 부분적으로 bind된 상태에서 호출됩니다. driver는 `probe()`와 다른 routine에서 흔히 `container_of()`로 `dev`를 bus-specific type으로 변환합니다. 그 type은 `pci_dev.resource[]`나 `platform_device.resources` 같은 resource data를 제공하며 `dev->platform_data`와 함께 초기화에 사용합니다.

callback에는 device 존재·지원 version 확인, driver data structure allocation과 초기화, hardware 초기화 같은 device-specific binding logic이 들어갑니다. driver는 흔히 `dev_set_drvdata()`로 state pointer를 저장합니다. 성공하면 0을 반환하고 driver model이 나머지 binding을 완료합니다.

bind하지 못하면 negative errno를 반환하고 자신이 할당한 모든 resource를 release해야 합니다. 아직 사용할 수 없는 다른 driver 제공 resource에 의존하면 `-EPROBE_DEFER`를 반환할 수 있습니다. core는 device를 deferred probe list에 넣고 나중에 다시 시도합니다. defer가 필요하다면 되돌릴 setup work를 줄이기 위해 가능한 한 일찍 반환해야 합니다.

경고: `probe()`가 이미 child device를 만들었다면 cleanup path에서 child를 다시 제거하더라도 `-EPROBE_DEFER`를 반환하면 안 됩니다. child 등록 뒤 defer하면 같은 driver의 `.probe()`가 무한 반복(`infinite loop`)될 수 있습니다.

sync_state callback

void        (*sync_state)        (struct device *dev);

`sync_state`는 device마다 한 번만 호출되며 device link로 연결된 모든 consumer device가 성공적으로 probe된 때 호출됩니다.

첫 시도는 firmware와 driver가 device link를 구성할 시간을 주기 위해 `late_initcall_sync()` 중에 합니다. 그 시점의 consumer가 모두 probe됐거나 consumer가 하나도 없으면 즉시 호출합니다.

아직 probe되지 않은 consumer가 있으면 호출을 미루고 이후 consumer 하나 이상이 성공적으로 probe될 때만 재시도합니다. 재시도 때도 미완료 consumer가 있으면 다시 미룹니다.

대표 용도는 bootloader에서 kernel로 device 관리를 안전하게 인계하는 것입니다. bootloader가 device를 켜고 특정 설정을 남긴 경우 모든 consumer가 probe될 때까지 그 boot 상태를 유지한 뒤 consumer가 요청한 aggregate software state에 hardware를 동기화합니다. regulator뿐 아니라 여러 consumer의 boot mapping을 유지해야 하는 IOMMU 같은 복잡한 resource에도 유용합니다.

bootloader 인계에만 제한되지 않으며 모든 consumer probe 뒤 수행해야 하는 action이라면 사용할 수 있습니다.

remove, suspend, resume callback

int         (*remove)        (struct device *dev);

`remove`는 device physical removal, driver module unload, reboot sequence 등의 상황에서 driver를 device에서 unbind할 때 호출됩니다. device 존재 여부는 driver가 판단하고 `driver_data` field 등 해당 device에 특별히 할당한 resource를 free해야 합니다. device가 남아 있다면 quiesce하고 지원되는 low-power state로 전환합니다.

int        (*suspend)        (struct device *dev, pm_message_t state);

`suspend`는 device를 low-power state로 전환합니다.

int        (*resume)        (struct device *dev);

`resume`은 device를 low-power state에서 복귀시킵니다.

Driver attribute

::

  struct driver_attribute {
          struct attribute        attr;
          ssize_t (*show)(struct device_driver *driver, char *buf);
          ssize_t (*store)(struct device_driver *, const char *buf, size_t count);
  };

device driver는 자신의 sysfs directory를 통해 attribute를 export할 수 있습니다. `DRIVER_ATTR_RW`와 `DRIVER_ATTR_RO` macro는 `DEVICE_ATTR_RW`와 `DEVICE_ATTR_RO`와 동일하게 동작합니다.

예시는 다음과 같습니다.

DRIVER_ATTR_RW(debug);

이는 다음 선언과 같습니다.

struct driver_attribute driver_attr_debug;

그 다음 아래 함수로 driver directory에 attribute를 추가하거나 제거합니다.

int driver_create_file(struct device_driver *, const struct driver_attribute *);
void driver_remove_file(struct device_driver *, const struct driver_attribute *);