Dell Remote BIOS Update driver | Linux 6.18.37

요약·해설과 원문, 전문 번역을 서로 분리했습니다. API 이름, symbol, source path는 원문 표기를 사용합니다.

1. 요약·해설

원문의 핵심 논리와 kernel programming 관점의 보충 설명입니다. 아래의 전문 번역과는 별도로 작성했습니다.

Driver와 update mechanism

dell_rbu.rst:1-87

지원 Dell system, application과 BIOS의 역할, monolithic 및 packetized physical memory layout과 sysfs control을 정리합니다.

Download, 정리와 reboot

dell_rbu.rst:88-128

Firmware loader command 순서, memory 해제, entry 복구, image readback과 최종 BIOS update request를 설명합니다.

2. 영어 원문 전체

번역 기준이 된 Linux v6.18.37 원문입니다. 줄 번호는 이 버전의 파일 좌표입니다.

원문 전체 펼치기

1 =========================================

2 Dell Remote BIOS Update driver (dell_rbu)

3 =========================================

5 Purpose

6 =======

8 Document demonstrating the use of the Dell Remote BIOS Update driver

9 for updating BIOS images on Dell servers and desktops.

11 Scope

12 =====

14 This document discusses the functionality of the rbu driver only.

15 It does not cover the support needed from applications to enable the BIOS to

16 update itself with the image downloaded in to the memory.

18 Overview

19 ========

21 This driver works with Dell OpenManage or Dell Update Packages for updating

22 the BIOS on Dell servers (starting from servers sold since 1999), desktops

23 and notebooks (starting from those sold in 2005).

25 Please go to http://support.dell.com register and you can find info on

26 OpenManage and Dell Update packages (DUP).

28 Libsmbios can also be used to update BIOS on Dell systems go to

29 https://linux.dell.com/libsmbios/ for details.

31 Dell_RBU driver supports BIOS update using the monolithic image and packetized

32 image methods. In case of monolithic the driver allocates a contiguous chunk

33 of physical pages having the BIOS image. In case of packetized the app

34 using the driver breaks the image in to packets of fixed sizes and the driver

35 would place each packet in contiguous physical memory. The driver also

36 maintains a link list of packets for reading them back.

38 If the dell_rbu driver is unloaded all the allocated memory is freed.

40 The rbu driver needs to have an application (as mentioned above) which will

41 inform the BIOS to enable the update in the next system reboot.

43 The user should not unload the rbu driver after downloading the BIOS image

44 or updating.

46 The driver load creates the following directories under the /sys file system::

48 /sys/class/firmware/dell_rbu/loading

49 /sys/class/firmware/dell_rbu/data

50 /sys/devices/platform/dell_rbu/image_type

51 /sys/devices/platform/dell_rbu/data

52 /sys/devices/platform/dell_rbu/packet_size

54 The driver supports two types of update mechanism; monolithic and packetized.

55 These update mechanism depends upon the BIOS currently running on the system.

56 Most of the Dell systems support a monolithic update where the BIOS image is

57 copied to a single contiguous block of physical memory.

59 In case of packet mechanism the single memory can be broken in smaller chunks

60 of contiguous memory and the BIOS image is scattered in these packets.

62 By default the driver uses monolithic memory for the update type. This can be

63 changed to packets during the driver load time by specifying the load

64 parameter image_type=packet. This can also be changed later as below::

66 echo packet > /sys/devices/platform/dell_rbu/image_type

68 In packet update mode the packet size has to be given before any packets can

69 be downloaded. It is done as below::

71 echo XXXX > /sys/devices/platform/dell_rbu/packet_size

73 In the packet update mechanism, the user needs to create a new file having

74 packets of data arranged back to back. It can be done as follows:

75 The user creates packets header, gets the chunk of the BIOS image and

76 places it next to the packetheader; now, the packetheader + BIOS image chunk

77 added together should match the specified packet_size. This makes one

78 packet, the user needs to create more such packets out of the entire BIOS

79 image file and then arrange all these packets back to back in to one single

80 file.

82 This file is then copied to /sys/class/firmware/dell_rbu/data.

83 Once this file gets to the driver, the driver extracts packet_size data from

84 the file and spreads it across the physical memory in contiguous packet_sized

85 space.

87 This method makes sure that all the packets get to the driver in a single operation.

89 In monolithic update the user simply get the BIOS image (.hdr file) and copies

90 to the data file as is without any change to the BIOS image itself.

92 Do the steps below to download the BIOS image.

94 1) echo 1 > /sys/class/firmware/dell_rbu/loading

95 2) cp bios_image.hdr /sys/class/firmware/dell_rbu/data

96 3) echo 0 > /sys/class/firmware/dell_rbu/loading

98 The /sys/class/firmware/dell_rbu/ entries will remain till the following is

99 done.

100

101 ::

102

103 echo -1 > /sys/class/firmware/dell_rbu/loading

104

105 Until this step is completed the driver cannot be unloaded.

106

107 Also echoing either mono, packet or init in to image_type will free up the

108 memory allocated by the driver.

109

110 If a user by accident executes steps 1 and 3 above without executing step 2;

111 it will make the /sys/class/firmware/dell_rbu/ entries disappear.

112

113 The entries can be recreated by doing the following::

114

115 echo init > /sys/devices/platform/dell_rbu/image_type

116

117 .. note:: echoing init in image_type does not change its original value.

118

119 Also the driver provides /sys/devices/platform/dell_rbu/data readonly file to

120 read back the image downloaded.

121

122 .. note::

123

124 After updating the BIOS image a user mode application needs to execute

125 code which sends the BIOS update request to the BIOS. So on the next reboot

126 the BIOS knows about the new image downloaded and it updates itself.

127 Also don't unload the rbu driver if the image has to be updated.

128

129

3. 한국어 전문 번역

영어 원문의 문단 순서와 의미를 유지한 전체 번역입니다. 코드, 함수명, symbol과 URL은 원문 표기를 유지합니다.

목적과 범위

1-17

이 문서는 Dell server와 desktop에서 BIOS image를 갱신할 때 Dell Remote BIOS Update driver인 `dell_rbu`를 사용하는 방법을 보여 줍니다.

범위는 RBU driver의 기능으로 한정됩니다. Memory로 내려받은 image를 사용해 BIOS가 스스로 update하도록 application이 제공해야 하는 지원은 다루지 않습니다.

지원 system, update model과 sysfs

18-53

이 driver는 Dell OpenManage 또는 Dell Update Packages를 사용해 1999년 이후 판매된 Dell server와 2005년 이후 판매된 desktop 및 notebook의 BIOS를 update합니다. OpenManage와 Dell Update Package(DUP) 정보는 `http://support.dell.com`에서 확인할 수 있고, Dell system의 BIOS update에는 `https://linux.dell.com/libsmbios/`의 `libsmbios`도 사용할 수 있습니다.

`Dell_RBU` driver는 monolithic image와 packetized image 방식의 BIOS update를 지원합니다. Monolithic 방식은 BIOS image를 담을 연속된 physical page chunk 하나를 할당합니다. Packetized 방식은 application이 image를 고정 크기 packet으로 나누고 driver가 각 packet을 연속 physical memory에 배치합니다. Driver는 packet을 다시 읽을 수 있도록 linked list도 유지합니다.

`dell_rbu` driver를 unload하면 할당된 memory가 모두 해제됩니다. RBU driver에는 다음 reboot에서 update를 활성화하라고 BIOS에 알리는 application이 필요합니다. BIOS image를 내려받거나 update하는 중에는 driver를 unload하지 않아야 합니다.

Driver load는 sysfs에 다음 file을 생성합니다.

	/sys/class/firmware/dell_rbu/loading
	/sys/class/firmware/dell_rbu/data
	/sys/devices/platform/dell_rbu/image_type
	/sys/devices/platform/dell_rbu/data
	/sys/devices/platform/dell_rbu/packet_size

dell_rbu sysfs interface

Path역할

`/sys/class/firmware/dell_rbu/loading`Firmware load state

`/sys/class/firmware/dell_rbu/data`Firmware image input

`/sys/devices/platform/dell_rbu/image_type`Monolithic/packet mode

`/sys/devices/platform/dell_rbu/data`Downloaded image readback

`/sys/devices/platform/dell_rbu/packet_size`Packet size configuration

Firmware loader와 platform driver interface를 구분합니다.

Dell BIOS update ownership

User applicationDownload BIOS image to dell_rbuDriver retains physical memoryApplication notifies BIOSSystem rebootBIOS applies image

Driver는 image memory를 준비하고 application이 reboot update request를 BIOS에 전달합니다.

Monolithic과 packetized mode

54-87

Driver는 monolithic과 packetized 두 update mechanism을 지원하며 사용할 방식은 현재 system의 BIOS에 따라 달라집니다. Dell system 대부분은 BIOS image를 연속 physical memory block 하나에 복사하는 monolithic update를 지원합니다. Packet mechanism에서는 memory를 더 작은 연속 chunk로 나누고 BIOS image를 여러 packet에 분산합니다.

기본 update type은 monolithic입니다. Driver load 때 `image_type=packet` parameter를 지정하거나 runtime에 다음 명령으로 packet mode로 바꿀 수 있습니다.

	echo packet > /sys/devices/platform/dell_rbu/image_type

Packet update mode에서는 packet을 내려받기 전에 packet size를 지정해야 합니다.

	echo XXXX > /sys/devices/platform/dell_rbu/packet_size

User는 packet data를 연속 배치한 새 file을 만듭니다. 각 packet은 packet header 뒤에 BIOS image chunk를 붙이며 `packetheader + BIOS image chunk`의 합이 지정한 `packet_size`와 같아야 합니다. 전체 BIOS image에서 이런 packet을 모두 만들고 한 file에 차례로 이어 붙입니다.

이 file을 `/sys/class/firmware/dell_rbu/data`로 복사하면 driver가 file에서 `packet_size`만큼씩 data를 추출해 physical memory의 연속된 packet-sized 영역에 분산합니다. 모든 packet을 한 operation으로 driver에 전달할 수 있는 방식입니다.

BIOS image update mode

ModeMemory layoutUser input

Monolithic연속 physical block 하나변경하지 않은 `.hdr` image

Packetized여러 연속 packet-sized blockHeader와 image chunk를 이어 붙인 file

BIOS capability에 따라 memory layout과 input preparation이 달라집니다.

Packetized image 구성

BIOS imageSplit into chunksPrepend packet headerMatch packet_sizeConcatenate packetsWrite dell_rbu/data onceDriver scatters packets

각 packet과 전체 upload file의 경계를 나타냅니다.

Image download와 memory 해제

88-108

Monolithic update에서는 user가 BIOS image인 `.hdr` file을 구해 image 자체를 변경하지 않고 data file로 복사합니다. BIOS image download 절차는 다음과 같습니다.

1) echo 1 > /sys/class/firmware/dell_rbu/loading
2) cp bios_image.hdr /sys/class/firmware/dell_rbu/data
3) echo 0 > /sys/class/firmware/dell_rbu/loading

`/sys/class/firmware/dell_rbu/` entry는 다음 명령을 실행할 때까지 남아 있습니다.

	echo -1 > /sys/class/firmware/dell_rbu/loading

이 단계를 완료하기 전에는 driver를 unload할 수 없습니다. `image_type`에 `mono`, `packet`, `init` 중 하나를 써도 driver가 할당한 memory를 해제합니다.

Firmware loader state

Write loading=1Copy bios_image.hdr to dataWrite loading=0Image retained for updateWrite loading=-1 or reset image_typeFree memory

Loading 시작, data write, 완료와 entry 정리의 순서입니다.

Entry 복구, readback과 reboot update

109-128

User가 실수로 위 절차의 2단계 data copy를 건너뛰고 1단계와 3단계만 실행하면 `/sys/class/firmware/dell_rbu/` entry가 사라집니다. 다음 명령으로 다시 만들 수 있습니다.

	echo init > /sys/devices/platform/dell_rbu/image_type

`image_type`에 `init`을 써도 원래 `image_type` 값은 바뀌지 않습니다.

Driver는 내려받은 image를 다시 읽을 수 있는 read-only file `/sys/devices/platform/dell_rbu/data`도 제공합니다.

BIOS image를 준비한 뒤 user-mode application이 BIOS update request를 BIOS로 보내는 code를 실행해야 합니다. 그래야 다음 reboot에서 BIOS가 새 image를 인식하고 update합니다. Image를 update해야 한다면 RBU driver를 unload하지 마십시오.

실수 복구와 최종 update

loading 1 then 0 without dataFirmware entries disappearWrite image_type=initEntries recreatedOriginal image_type retained

Image downloadedUser-mode app sends BIOS update requestKeep driver loadedRebootBIOS updates

Entry 재생성은 image_type을 바꾸지 않으며 실제 BIOS 적용에는 별도 application request가 필요합니다.