Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
dell_rbu.txt: standardize document format
Each text file under Documentation follows a different
format. Some doesn't even have titles!
Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx.
Currently, the document is completely unformatted. Add
titles, do indentation, mark literal blocks.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
authored by Mauro Carvalho Chehab and committed by Jonathan Corbet 58ef0e5b 998ff0b5
+56
-25
Documentation/dell_rbu.txt
+56
-25
Documentation/dell_rbu.txt
···
1
-
Purpose:
2
-
Demonstrate the usage of the new open sourced rbu (Remote BIOS Update) driver
1
+
=============================================================
2
+
Usage of the new open sourced rbu (Remote BIOS Update) driver
3
+
=============================================================
4
+
5
+
Purpose
6
+
=======
7
+
8
+
Document demonstrating the use of the Dell Remote BIOS Update driver.
3
9
for updating BIOS images on Dell servers and desktops.
4
10
5
-
Scope:
11
+
Scope
12
+
=====
13
+
6
14
This document discusses the functionality of the rbu driver only.
7
15
It does not cover the support needed from applications to enable the BIOS to
8
16
update itself with the image downloaded in to the memory.
9
17
10
-
Overview:
18
+
Overview
19
+
========
20
+
11
21
This driver works with Dell OpenManage or Dell Update Packages for updating
12
22
the BIOS on Dell servers (starting from servers sold since 1999), desktops
13
23
and notebooks (starting from those sold in 2005).
24
+
14
25
Please go to http://support.dell.com register and you can find info on
15
26
OpenManage and Dell Update packages (DUP).
27
+
16
28
Libsmbios can also be used to update BIOS on Dell systems go to
17
29
http://linux.dell.com/libsmbios/ for details.
18
30
···
34
22
using the driver breaks the image in to packets of fixed sizes and the driver
35
23
would place each packet in contiguous physical memory. The driver also
36
24
maintains a link list of packets for reading them back.
25
+
37
26
If the dell_rbu driver is unloaded all the allocated memory is freed.
38
27
39
28
The rbu driver needs to have an application (as mentioned above)which will
···
43
30
The user should not unload the rbu driver after downloading the BIOS image
44
31
or updating.
45
32
46
-
The driver load creates the following directories under the /sys file system.
47
-
/sys/class/firmware/dell_rbu/loading
48
-
/sys/class/firmware/dell_rbu/data
49
-
/sys/devices/platform/dell_rbu/image_type
50
-
/sys/devices/platform/dell_rbu/data
51
-
/sys/devices/platform/dell_rbu/packet_size
33
+
The driver load creates the following directories under the /sys file system::
34
+
35
+
/sys/class/firmware/dell_rbu/loading
36
+
/sys/class/firmware/dell_rbu/data
37
+
/sys/devices/platform/dell_rbu/image_type
38
+
/sys/devices/platform/dell_rbu/data
39
+
/sys/devices/platform/dell_rbu/packet_size
52
40
53
41
The driver supports two types of update mechanism; monolithic and packetized.
54
42
These update mechanism depends upon the BIOS currently running on the system.
55
43
Most of the Dell systems support a monolithic update where the BIOS image is
56
44
copied to a single contiguous block of physical memory.
45
+
57
46
In case of packet mechanism the single memory can be broken in smaller chunks
58
47
of contiguous memory and the BIOS image is scattered in these packets.
59
48
60
49
By default the driver uses monolithic memory for the update type. This can be
61
50
changed to packets during the driver load time by specifying the load
62
-
parameter image_type=packet. This can also be changed later as below
63
-
echo packet > /sys/devices/platform/dell_rbu/image_type
51
+
parameter image_type=packet. This can also be changed later as below::
52
+
53
+
echo packet > /sys/devices/platform/dell_rbu/image_type
64
54
65
55
In packet update mode the packet size has to be given before any packets can
66
-
be downloaded. It is done as below
67
-
echo XXXX > /sys/devices/platform/dell_rbu/packet_size
56
+
be downloaded. It is done as below::
57
+
58
+
echo XXXX > /sys/devices/platform/dell_rbu/packet_size
59
+
68
60
In the packet update mechanism, the user needs to create a new file having
69
61
packets of data arranged back to back. It can be done as follows
70
62
The user creates packets header, gets the chunk of the BIOS image and
···
78
60
packet, the user needs to create more such packets out of the entire BIOS
79
61
image file and then arrange all these packets back to back in to one single
80
62
file.
63
+
81
64
This file is then copied to /sys/class/firmware/dell_rbu/data.
82
65
Once this file gets to the driver, the driver extracts packet_size data from
83
66
the file and spreads it across the physical memory in contiguous packet_sized
84
67
space.
68
+
85
69
This method makes sure that all the packets get to the driver in a single operation.
86
70
87
71
In monolithic update the user simply get the BIOS image (.hdr file) and copies
88
72
to the data file as is without any change to the BIOS image itself.
89
73
90
74
Do the steps below to download the BIOS image.
75
+
91
76
1) echo 1 > /sys/class/firmware/dell_rbu/loading
92
77
2) cp bios_image.hdr /sys/class/firmware/dell_rbu/data
93
78
3) echo 0 > /sys/class/firmware/dell_rbu/loading
94
79
95
80
The /sys/class/firmware/dell_rbu/ entries will remain till the following is
96
81
done.
97
-
echo -1 > /sys/class/firmware/dell_rbu/loading
82
+
83
+
::
84
+
85
+
echo -1 > /sys/class/firmware/dell_rbu/loading
86
+
98
87
Until this step is completed the driver cannot be unloaded.
88
+
99
89
Also echoing either mono, packet or init in to image_type will free up the
100
90
memory allocated by the driver.
101
91
102
92
If a user by accident executes steps 1 and 3 above without executing step 2;
103
93
it will make the /sys/class/firmware/dell_rbu/ entries disappear.
104
-
The entries can be recreated by doing the following
105
-
echo init > /sys/devices/platform/dell_rbu/image_type
106
-
NOTE: echoing init in image_type does not change it original value.
94
+
95
+
The entries can be recreated by doing the following::
96
+
97
+
echo init > /sys/devices/platform/dell_rbu/image_type
98
+
99
+
.. note:: echoing init in image_type does not change it original value.
107
100
108
101
Also the driver provides /sys/devices/platform/dell_rbu/data readonly file to
109
102
read back the image downloaded.
110
103
111
-
NOTE:
112
-
This driver requires a patch for firmware_class.c which has the modified
113
-
request_firmware_nowait function.
114
-
Also after updating the BIOS image a user mode application needs to execute
115
-
code which sends the BIOS update request to the BIOS. So on the next reboot
116
-
the BIOS knows about the new image downloaded and it updates itself.
117
-
Also don't unload the rbu driver if the image has to be updated.
104
+
.. note::
105
+
106
+
This driver requires a patch for firmware_class.c which has the modified
107
+
request_firmware_nowait function.
108
+
109
+
Also after updating the BIOS image a user mode application needs to execute
110
+
code which sends the BIOS update request to the BIOS. So on the next reboot
111
+
the BIOS knows about the new image downloaded and it updates itself.
112
+
Also don't unload the rbu driver if the image has to be updated.
118
113