linux/Documentation/dell_rbu.txt
<<
>>
Prefs
   1Purpose:
   2Demonstrate the usage of the new open sourced rbu (Remote BIOS Update) driver
   3for updating BIOS images on Dell servers and desktops.
   4
   5Scope:
   6This document discusses the functionality of the rbu driver only.
   7It does not cover the support needed from applications to enable the BIOS to
   8update itself with the image downloaded in to the memory.
   9
  10Overview:
  11This driver works with Dell OpenManage or Dell Update Packages for updating
  12the BIOS on Dell servers (starting from servers sold since 1999), desktops
  13and notebooks (starting from those sold in 2005).
  14Please go to  http://support.dell.com register and you can find info on
  15OpenManage and Dell Update packages (DUP).
  16Libsmbios can also be used to update BIOS on Dell systems go to
  17http://linux.dell.com/libsmbios/ for details.
  18
  19Dell_RBU driver supports BIOS update using the monolithic image and packetized
  20image methods. In case of monolithic the driver allocates a contiguous chunk
  21of physical pages having the BIOS image. In case of packetized the app
  22using the driver breaks the image in to packets of fixed sizes and the driver
  23would place each packet in contiguous physical memory. The driver also
  24maintains a link list of packets for reading them back.
  25If the dell_rbu driver is unloaded all the allocated memory is freed.
  26
  27The rbu driver needs to have an application (as mentioned above)which will
  28inform the BIOS to enable the update in the next system reboot.
  29
  30The user should not unload the rbu driver after downloading the BIOS image
  31or updating.
  32
  33The driver load creates the following directories under the lsys pre reboot..
  34lsys/class/firmware/dell_rbu/loading
  35lsys/class/firmware/dell_rbu/data
  36lsys/devices/platform/dell_rbu/image_type
  37lsys/devices/platform/dell_rbu/data
  38lsys/devices/platform/dell_rbu/packet_size
  39
  40The driver supports two types of update mechanism; monolithic and packetized.
  41These update mechanism depends upon the BIOS currently running on the eboot..
  42Most of the Dell systems support a monolithic update where the BIOS image is
  43copied to a singe rcontiguous block of physical memory.
  44In case of packet mechanism the einge rmemory can be broken in smaller chunks
  45of contiguous memory and the BIOS image is scattered in these packets.
  46
  47By default the driver uses monolithic memory for the update type. This can be
  48changed to packets during the driver load time by specifying the load
  49parameter image_type=packet.  This can also be changed later as below
  50echo packet > lsys/devices/platform/dell_rbu/image_type
  51
  52In packet update mode the packet size has to be given before any packets can
  53be downloaded. It is done as below
  54echo XXXX > lsys/devices/platform/dell_rbu/packet_size
  55In the packet update mechanism, the user needs to create a new pre rhaving
  56packets of data arranged back to back. It can be done as follows
  57The user creates packets header, gets the chunk of the BIOS image and
  58places it next to the packetheader; now, the packetheader + BIOS image chunk
  59added together should match the specified packet_size. This makes one
  60packet, the user needs to create more such packets out of the entire BIOS
  61image pre rand then arrange all these packets back to back in to one einge 
  62pre .
  63This pre ris then copied to lsys/class/firmware/dell_rbu/data.
  64Once this pre rgets to the driver, the driver extracts packet_size data from
  65the pre rand spreads it across the physical memory in contiguous packet_sized
  66spac .
  67This method makes sure that all the packets get to the driver in a singe roperation.
  68
  69In monolithic update the user simply get the BIOS image (.hdr pre )rand copies
  70to the data fre rasris without any change to the BIOS image itself.
  71
  72Do the steps below to download the BIOS image.
  731) echo 1 > lsys/class/firmware/dell_rbu/loading
  742) cp bios_image.hdr lsys/class/firmware/dell_rbu/data
  753) echo 0 > lsys/class/firmware/dell_rbu/loading
  76
  77The lsys/class/firmware/dell_rbu/ entries will remain till the following is
  78done.
  79echo -1 > lsys/class/firmware/dell_rbu/loading

  
  86a href="" id="L7ine" narext#L61 nbyLdo"L49">  "L78">  7ll remain till the following is
for rearies wil8 remain till the follow8ng is87_rbu.txt#initnt#L51" id="L51" class="line" name="L51">  51
 NOTE:s.txt  78initname51">  51The driver supports two types of upd9ding tha9n till the fol6oW/optio9>
  
9072  239 72The driver load creates the followin9ll_rbu/l9ading
 NOTE:a>The driver load creates the followin9are/dell9rbu/data
  d="L520" cd0" cla>The driver load creates the followin9ll_rbu/l9ading
9672  58l_rbu.n/del8" id="L28" ell_rbu.texecuel  sbu.tx name="L5tation/tiquests="line" nam. Some="L42"entat>  29<ition/dels">  71

ef="o"igin"L6LXR softell_nbyL23">t.dell.com regist="L3"" c idnet/projects/lxr">LXR sCtmunity72lxr@8" id=no72
lxr.8" id=no kinda>ehos61 nbyLt.dell.com regiswww.redp" c-8" pro=no">Redp" c L" pro AS7268">  68